Skip to content

Commit

Permalink
docs: Links to akka-edge-rs API docs (#1119)
Browse files Browse the repository at this point in the history
  • Loading branch information
patriknw authored Jan 29, 2024
1 parent d27c199 commit 5c00cf3
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 7 deletions.
1 change: 1 addition & 0 deletions akka-edge-docs/src/main/paradox/guide-rs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -73,4 +73,4 @@ Rust

## What's next?

* Producing temperature events
* Producing temperature events
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -74,4 +74,4 @@ Rust

## What's next?

* HTTP temperature events
* HTTP temperature events
4 changes: 3 additions & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 5c00cf3

Please sign in to comment.