Skip to content

[Docs] Akka.Delivery Documentation #6757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 34 commits into from
May 16, 2023

Conversation

Aaronontheweb
Copy link
Member

@Aaronontheweb Aaronontheweb commented May 10, 2023

Changes

Adds documentation for #6720

Checklist

For significant changes, please ensure that the following have been completed (delete if not relevant):

@Aaronontheweb Aaronontheweb marked this pull request as ready for review May 16, 2023 17:48
Copy link
Member Author

@Aaronontheweb Aaronontheweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Detailed some of my changes aside from the main pages in the documentation.

@@ -11,6 +11,7 @@
[assembly: System.Runtime.CompilerServices.InternalsVisibleToAttribute("Akka.Cluster.Tools")]
[assembly: System.Runtime.CompilerServices.InternalsVisibleToAttribute("Akka.DependencyInjection")]
[assembly: System.Runtime.CompilerServices.InternalsVisibleToAttribute("Akka.DistributedData")]
[assembly: System.Runtime.CompilerServices.InternalsVisibleToAttribute("Akka.Docs.Tests")]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had to make InteralsVisibleTo the Akka.Docs.Tests project in order to take advantage of Polyfill.

@@ -2,7 +2,7 @@
<PropertyGroup>
<Copyright>Copyright © 2013-2023 Akka.NET Team</Copyright>
<Authors>Akka.NET Team</Authors>
<VersionPrefix>1.5.4</VersionPrefix>
<VersionPrefix>1.5.7</VersionPrefix>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a metadata update from running local build commands

@@ -2,7 +2,10 @@
uid: at-least-once-delivery
title: At-Least-Once Delivery
---
# At-Least-Once Delivery
# At-Least-Once Delivery (Obsolete)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marking AtLeastOnceDelivery actors as obsolete in the documentation.

@@ -1,8 +1,8 @@
---
uid: cluster-sharding
title: Akka.Cluster.Sharding module
title: Akka.Cluster.Sharding - Reliable, Automatic State Distribution with Akka.Cluster
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a better <title> tag for SEO and discovery

# At-Least-Once Delivery (Obsolete)

> [!WARNING]
> `AtLeastOnceDelivery` actors in Akka.Persistence are being deprecated in favor of [Akka.Delivery](xref:reliable-delivery) and [Akka.Cluster.Sharding.Delivery](xref:cluster-sharding-delivery). Please look at those articles for further details.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linking to our reliable delivery documentation

@@ -7,6 +7,9 @@ title: Remote Messaging

Once you [form an association between two `ActorSystem`s](xref:remote-overview#how-to-form-associations-between-remote-systems), you can now send messages transparently between actors regardless of where they are on the network.

> [!IMPORTANT]
> See "[Reliable Akka.NET Message Delivery with Akka.Delivery](xref:reliable-delivery)" for tips on how to achieve reliable messaging over Akka.Remote and Akka.Cluster.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Referencing reliable delivery from the Akka.Remote documentation.

@Aaronontheweb Aaronontheweb merged commit 3e1b8e5 into akkadotnet:dev May 16, 2023
@Aaronontheweb Aaronontheweb deleted the reliable-delivery-docs branch May 16, 2023 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant