From fee479038db7c599d7c3ff911ca4582a6c173a6a Mon Sep 17 00:00:00 2001 From: danielle9897 Date: Tue, 17 Sep 2024 16:39:33 +0300 Subject: [PATCH] RDoc-3016 Fix comments for RavenDB plugin for Akka.NET Persistence --- .../events-and-snapshots.markdown | 4 ++-- ...integrating-with-akka-persistence.markdown | 21 +++++++++++++++++-- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/Documentation/6.2/Raven.Documentation.Pages/integrations/akka.net-persistence/events-and-snapshots.markdown b/Documentation/6.2/Raven.Documentation.Pages/integrations/akka.net-persistence/events-and-snapshots.markdown index 5522d9f8f..af6e6766f 100644 --- a/Documentation/6.2/Raven.Documentation.Pages/integrations/akka.net-persistence/events-and-snapshots.markdown +++ b/Documentation/6.2/Raven.Documentation.Pages/integrations/akka.net-persistence/events-and-snapshots.markdown @@ -118,7 +118,7 @@ Each snapshot document includes the following fields, among others: * RavenDB is a distributed database, allowing writes, reads, and queries to target different nodes across the cluster. * To prioritize consistency over availability, the RavenDB plugin uses a [cluster-wide transaction](../../server/clustering/cluster-transactions) for storing events and snapshot documents. - This ensures that persisted data is consistently applied across all database instances in the cluster, fulfilling Akka's requirement for no gaps in event sequence numbers at any point in time, across all nodes. + This ensures that persisted data is consistently applied across all database instances in the cluster, preventing conflicts and guaranteeing that restoring to the latest state reflects the correct event sequence, as required by Akka. * Note that cluster consensus is required for a cluster-wide transaction to execute. This means that a majority of nodes in the [database group](../../studio/database/settings/manage-database-group) must be up and connected in order to persist new events & snapshots. @@ -186,4 +186,4 @@ The data stored for each event is an instance of the `Sale` class, containing `P ### Integrations [Integrating with Akka.Persistence](../../integrations/akka.net-persistence/integrating-with-akka-persistence) -[Queries](../todo..) +[Queries](../../integrations/akka.net-persistence/queries) diff --git a/Documentation/6.2/Raven.Documentation.Pages/integrations/akka.net-persistence/integrating-with-akka-persistence.markdown b/Documentation/6.2/Raven.Documentation.Pages/integrations/akka.net-persistence/integrating-with-akka-persistence.markdown index 588b5890d..96f1f53b4 100644 --- a/Documentation/6.2/Raven.Documentation.Pages/integrations/akka.net-persistence/integrating-with-akka-persistence.markdown +++ b/Documentation/6.2/Raven.Documentation.Pages/integrations/akka.net-persistence/integrating-with-akka-persistence.markdown @@ -68,12 +68,24 @@ Integrate RavenDB with Akka.Persistence using one of the two available NuGet pac * [Akka.Persistence.RavenDB](https://www.nuget.org/packages/Akka.Persistence.RavenDB) This package allows you to configure the plugin solely through HOCON (Human-Optimized Config Object Notation), - which is typically embedded within your _app.config_ or _web.config_ file, or a dedicated HOCON file. - + which is typically embedded within your _app.config_ or _web.config_ file, or a dedicated HOCON file. + + {CODE-BLOCK: powershell} +# Installing via .NET CLI: +dotnet add package Akka.Persistence.RavenDB + {CODE-BLOCK/} + * [Akka.Persistence.RavenDB.Hosting](https://www.nuget.org/packages/Akka.Persistence.RavenDB.Hosting) This package includes the base _Akka.Persistence.RavenDB_, offering greater flexibility by allowing you to configure the plugin through **Hosting** or via a **HOCON** configuration file. Using Hosting provides a fast and easy way to set up your app and its persistence without the need to configure HOCON. + + {CODE-BLOCK: powershell} +# Installing via .NET CLI: +dotnet add package Akka.Persistence.RavenDB.Hosting + {CODE-BLOCK/} + +--- Installing either package will also install the _Akka.Persistence_ package. @@ -218,3 +230,8 @@ Default: `false` [Events and Snapshots](../../integrations/akka.net-persistence/events-and-snapshots) [Queries](../../integrations/akka.net-persistence/queries) + +### RavenDB Articles + +[Using RavenDB Persistence in an Akka.NET application](https://ravendb.net/articles/using-ravendb-persistence-in-an-akka-net-application) +[Notes from integrating RavenDB with Akka.NET Persistence](https://ravendb.net/articles/notes-from-integrating-ravendb-with-akka-net-persistence)