From 5c00cf3219e57a19a8a771db8309e7d5e51f7a5e Mon Sep 17 00:00:00 2001 From: Patrik Nordwall Date: Mon, 29 Jan 2024 10:29:16 +0100 Subject: [PATCH] docs: Links to akka-edge-rs API docs (#1119) --- akka-edge-docs/src/main/paradox/guide-rs.md | 1 + .../src/main/paradox/guide-rs/3-temperature-entity.md | 4 ++-- .../src/main/paradox/guide-rs/4-registration-projection.md | 4 ++-- .../src/main/paradox/guide-rs/5-temperature-production.md | 4 ++-- build.sbt | 4 +++- 5 files changed, 10 insertions(+), 7 deletions(-) diff --git a/akka-edge-docs/src/main/paradox/guide-rs.md b/akka-edge-docs/src/main/paradox/guide-rs.md index a13c01702..6c866f3c0 100644 --- a/akka-edge-docs/src/main/paradox/guide-rs.md +++ b/akka-edge-docs/src/main/paradox/guide-rs.md @@ -42,3 +42,4 @@ a React-like framework known as [Yew](https://yew.rs/). @@@ +See also @extref:[API documentation](akka-edge-rs-api:index.html). diff --git a/akka-edge-docs/src/main/paradox/guide-rs/3-temperature-entity.md b/akka-edge-docs/src/main/paradox/guide-rs/3-temperature-entity.md index 24f7488b9..3f8a91a52 100644 --- a/akka-edge-docs/src/main/paradox/guide-rs/3-temperature-entity.md +++ b/akka-edge-docs/src/main/paradox/guide-rs/3-temperature-entity.md @@ -84,7 +84,7 @@ The structure for our temperature entity is as follows: Rust : @@snip [temperature.rs](/samples/grpc/iot-service-rs/backend/src/temperature.rs) { #behavior-1 } -An entity behavior declaration associates the types used for the state, commands, and events of an entity instances. The +An @extref:[`EventSourcedBehavior`](akka-edge-rs-api:akka_persistence_rs/entity/trait.EventSourcedBehavior.html) declaration associates the types used for the state, commands, and events of an entity instances. The declaration also includes how the entity's commands are processed, and how events are applied to state. Note that it is impossible to update state from a command handler as it is immutable by design. Updating state only via the event handler enables entities to be sourced from their stored events without effects. @@ -145,7 +145,7 @@ Rust ## Running the entity manager -We are now ready to run the entity manager. An entity manager task handles the lifecycle +We are now ready to run the @extref:[entity manager](akka-edge-rs-api:akka_persistence_rs/entity_manager/index.html). An entity manager task handles the lifecycle and routing of messages per type of entity. Rust diff --git a/akka-edge-docs/src/main/paradox/guide-rs/4-registration-projection.md b/akka-edge-docs/src/main/paradox/guide-rs/4-registration-projection.md index 331fbfcfa..6079ea1a6 100644 --- a/akka-edge-docs/src/main/paradox/guide-rs/4-registration-projection.md +++ b/akka-edge-docs/src/main/paradox/guide-rs/4-registration-projection.md @@ -27,7 +27,7 @@ Each offset store must also have a distinct identity also, hence the `offset-sto ## The gRPC source provider -We use a gRPC source provider to source events from a remote producer. The remote endpoint is declared as a function +We use a @extref:[`GrpcSourceProvider`](akka-edge-rs-api:akka_projection_rs_grpc/consumer/struct.GrpcSourceProvider.html) to source events from a remote producer. The remote endpoint is declared as a function that establishes a gRPC connection. This function can be enhanced to establish the connection flexibly e.g. we can establish a TLS-based connection or even a Unix Domain Socket based connection if desired. @@ -73,4 +73,4 @@ Rust ## What's next? -* Producing temperature events \ No newline at end of file +* Producing temperature events diff --git a/akka-edge-docs/src/main/paradox/guide-rs/5-temperature-production.md b/akka-edge-docs/src/main/paradox/guide-rs/5-temperature-production.md index 67566b3e9..21ab6648d 100644 --- a/akka-edge-docs/src/main/paradox/guide-rs/5-temperature-production.md +++ b/akka-edge-docs/src/main/paradox/guide-rs/5-temperature-production.md @@ -31,7 +31,7 @@ Rust ## The producer -A "sink" of envelopes is established that forward on to a remote consumer via a producer "flow". The flow will be used +A "sink" of envelopes is established that forward on to a remote consumer via a @extref:[producer flow](akka-edge-rs-api:akka_projection_rs_grpc/producer/index.html). The flow will be used to bridge between source of events and this sink. A great deal of flexibility is provided in terms of expressing how the remote consumer's endpoint is established via the @@ -74,4 +74,4 @@ Rust ## What's next? -* HTTP temperature events \ No newline at end of file +* HTTP temperature events diff --git a/build.sbt b/build.sbt index 36f15e60a..42b1d1eee 100644 --- a/build.sbt +++ b/build.sbt @@ -301,7 +301,9 @@ lazy val `akka-edge-docs` = project "extref.akka-projection.base_url" -> s"https://doc.akka.io/docs/akka-projection/${Dependencies.AkkaProjectionVersionInDocs}/%s", "scaladoc.akka.projection.base_url" -> s"https://doc.akka.io/api/akka-projection/${Dependencies.AkkaProjectionVersionInDocs}/", "extref.akka-distributed-cluster.base_url" -> s"https://doc.akka.io/docs/akka-distributed-cluster/${Dependencies.AkkaProjectionVersionInDocs}/%s", - "extref.akka-persistence-r2dbc.base_url" -> s"https://doc.akka.io/docs/akka-persistence-r2dbc/${Dependencies.AkkaPersistenceR2dbcVersionInDocs}/%s"), + "extref.akka-persistence-r2dbc.base_url" -> s"https://doc.akka.io/docs/akka-persistence-r2dbc/${Dependencies.AkkaPersistenceR2dbcVersionInDocs}/%s", + // API docs for akka-edge-rs + "extref.akka-edge-rs-api.base_url" -> s"https://doc.akka.io/api/akka-edge-rs/current/%s"), paradoxGroups := Map("Language" -> Seq("Java", "Scala")), paradoxRoots := List("index.html"), resolvers += Resolver.jcenterRepo,