From 7fe280b7b64adff2ffbdee1e40842b7a1b68d72a Mon Sep 17 00:00:00 2001 From: Patrik Nordwall Date: Mon, 18 Nov 2019 11:23:28 +0200 Subject: [PATCH] fix links to samples (#28145) * fix links to samples * remove activator links to fsm-sample * we are reducing the number of samples to maintain and since samples are mostly interesting for new users most of them will be based on Akka Typed --- akka-docs/src/main/paradox/actors.md | 4 +--- .../src/main/paradox/multi-jvm-testing.md | 2 +- .../src/main/paradox/persistence-query.md | 4 ++-- .../src/main/paradox/project/examples.md | 24 +++++++++---------- .../main/paradox/typed/cluster-sharding.md | 4 ++-- .../main/paradox/typed/distributed-data.md | 4 ++-- akka-docs/src/main/paradox/typed/fsm.md | 4 ++-- .../src/main/paradox/typed/persistence.md | 12 +++++----- 8 files changed, 28 insertions(+), 30 deletions(-) diff --git a/akka-docs/src/main/paradox/actors.md b/akka-docs/src/main/paradox/actors.md index a5b7f9baad..a34dcb83a8 100644 --- a/akka-docs/src/main/paradox/actors.md +++ b/akka-docs/src/main/paradox/actors.md @@ -1061,9 +1061,7 @@ Java : @@snip [ActorDocTest.java](/akka-docs/src/test/java/jdocs/actor/ActorDocTest.java) { #hot-swap-actor } This variant of the `become` method is useful for many different things, -such as to implement a Finite State Machine (FSM, for an example see @scala[[Dining -Hakkers](http://www.lightbend.com/activator/template/akka-sample-fsm-scala)).] @java[[Dining -Hakkers](http://www.lightbend.com/activator/template/akka-sample-fsm-java-lambda)).] It will replace the current behavior (i.e. the top of the behavior +such as to implement a Finite State Machine (FSM). It will replace the current behavior (i.e. the top of the behavior stack), which means that you do not use `unbecome`, instead always the next behavior is explicitly installed. diff --git a/akka-docs/src/main/paradox/multi-jvm-testing.md b/akka-docs/src/main/paradox/multi-jvm-testing.md index 447e930062..be4a362afb 100644 --- a/akka-docs/src/main/paradox/multi-jvm-testing.md +++ b/akka-docs/src/main/paradox/multi-jvm-testing.md @@ -211,7 +211,7 @@ described in that section. ## Example project -@extref[Cluster example project](samples:akka-sample-cluster-scala) +@extref[Cluster example project](samples:akka-samples-cluster-scala) is an example project that can be downloaded, and with instructions of how to run. This project illustrates Cluster features and also includes Multi JVM Testing with the `sbt-multi-jvm` plugin. diff --git a/akka-docs/src/main/paradox/persistence-query.md b/akka-docs/src/main/paradox/persistence-query.md index 0c5bcdf5a6..b393253d61 100644 --- a/akka-docs/src/main/paradox/persistence-query.md +++ b/akka-docs/src/main/paradox/persistence-query.md @@ -350,8 +350,8 @@ TODO, not available yet. ## Example project -@java[@extref[CQRS example project](samples:akka-sample-cqrs-java)] -@scala[@extref[CQRS example project](samples:akka-sample-cqrs-scala)] +@java[@extref[CQRS example project](samples:akka-samples-cqrs-java)] +@scala[@extref[CQRS example project](samples:akka-samples-cqrs-scala)] is an example project that can be downloaded, and with instructions of how to run. This project contains a Shopping Cart sample illustrating how to use Akka Persistence. diff --git a/akka-docs/src/main/paradox/project/examples.md b/akka-docs/src/main/paradox/project/examples.md index d39a4ba3c5..430bf291a1 100644 --- a/akka-docs/src/main/paradox/project/examples.md +++ b/akka-docs/src/main/paradox/project/examples.md @@ -13,8 +13,8 @@ messages as well as how to use the test module and logging. ## FSM -@java[@extref[FSM example project](samples:akka-sample-fsm-java)] -@scala[@extref[FSM example project](samples:akka-sample-fsm-scala)] +@java[@extref[FSM example project](samples:akka-samples-fsm-java)] +@scala[@extref[FSM example project](samples:akka-samples-fsm-scala)] This project contains a Dining Hakkers sample illustrating how to model a Finite State Machine (FSM) with actors. @@ -31,29 +31,29 @@ It also includes Multi JVM Testing with the `sbt-multi-jvm` plugin. ## Distributed Data -@java[@extref[Distributed Data example project](samples:akka-sample-distributed-data-java)] -@scala[@extref[Distributed Data example project](samples:akka-sample-distributed-data-scala)] +@java[@extref[Distributed Data example project](samples:akka-samples-distributed-data-java)] +@scala[@extref[Distributed Data example project](samples:akka-samples-distributed-data-scala)] This project contains several samples illustrating how to use Distributed Data. ## Cluster Sharding -@java[@extref[Sharding example project](samples:akka-sample-sharding-java)] -@scala[@extref[Sharding example project](samples:akka-sample-sharding-scala)] +@java[@extref[Sharding example project](samples:akka-samples-cluster-sharding-java)] +@scala[@extref[Sharding example project](samples:akka-samples-cluster-sharding-scala)] This project contains a KillrWeather sample illustrating how to use Cluster Sharding. ## Persistence -@java[@extref[Persistence example project](samples:akka-sample-persistence-java)] -@scala[@extref[Persistence example project](samples:akka-sample-persistence-scala)] +@java[@extref[Persistence example project](samples:akka-samples-persistence-java)] +@scala[@extref[Persistence example project](samples:akka-samples-persistence-scala)] This project contains a Shopping Cart sample illustrating how to use Akka Persistence. ## CQRS -@java[@extref[CQRS example project](samples:akka-sample-cqrs-java)] -@scala[@extref[CQRS example project](samples:akka-sample-cqrs-scala)] +@java[@extref[CQRS example project](samples:akka-samples-cqrs-java)] +@scala[@extref[CQRS example project](samples:akka-samples-cqrs-scala)] This project contains a Shopping Cart sample illustrating how to use Akka Persistence. The events are tagged to be consumed by even processors to build other representations @@ -61,8 +61,8 @@ from the events, or publish the events to other services. ## Multi-DC Persistence -@java[@extref[Multi-DC Persistence example project](samples:akka-sample-persistence-dc-java)] -@scala[@extref[Multi-DC Persistence example project](samples:akka-sample-persistence-dc-scala)] +@java[@extref[Multi-DC Persistence example project](samples:akka-samples-persistence-dc-java)] +@scala[@extref[Multi-DC Persistence example project](samples:akka-samples-persistence-dc-scala)] Illustrates how to use Lightbend's [Multi-DC Persistence](https://doc.akka.io/docs/akka-enhancements/current/persistence-dc/index.html) with active-active persistent entities across data centers. diff --git a/akka-docs/src/main/paradox/typed/cluster-sharding.md b/akka-docs/src/main/paradox/typed/cluster-sharding.md index d48d50075c..6c10cc5f8a 100644 --- a/akka-docs/src/main/paradox/typed/cluster-sharding.md +++ b/akka-docs/src/main/paradox/typed/cluster-sharding.md @@ -411,8 +411,8 @@ One important configuration property is `number-of-shards` as described in @ref: ## Example project -@java[@extref[Sharding example project](samples:akka-sample-sharding-java)] -@scala[@extref[Sharding example project](samples:akka-sample-sharding-scala)] +@java[@extref[Sharding example project](samples:akka-samples-cluster-sharding-java)] +@scala[@extref[Sharding example project](samples:akka-samples-cluster-sharding-scala)] is an example project that can be downloaded, and with instructions of how to run. This project contains a KillrWeather sample illustrating how to use Cluster Sharding. diff --git a/akka-docs/src/main/paradox/typed/distributed-data.md b/akka-docs/src/main/paradox/typed/distributed-data.md index 4a9d6664e4..fb56b323cf 100644 --- a/akka-docs/src/main/paradox/typed/distributed-data.md +++ b/akka-docs/src/main/paradox/typed/distributed-data.md @@ -762,8 +762,8 @@ The `DistributedData` extension can be configured with the following properties: ## Example project -@java[@extref[Distributed Data example project](samples:akka-sample-distributed-data-java)] -@scala[@extref[Distributed Data example project](samples:akka-sample-distributed-data-scala)] +@java[@extref[Distributed Data example project](samples:akka-samples-distributed-data-java)] +@scala[@extref[Distributed Data example project](samples:akka-samples-distributed-data-scala)] is an example project that can be downloaded, and with instructions of how to run. This project contains several samples illustrating how to use Distributed Data. diff --git a/akka-docs/src/main/paradox/typed/fsm.md b/akka-docs/src/main/paradox/typed/fsm.md index 437bc3ff42..02136e7b20 100644 --- a/akka-docs/src/main/paradox/typed/fsm.md +++ b/akka-docs/src/main/paradox/typed/fsm.md @@ -47,8 +47,8 @@ To set state timeouts use `Behaviors.withTimers` along with a `startSingleTimer` ## Example project -@java[@extref[FSM example project](samples:akka-sample-fsm-java)] -@scala[@extref[FSM example project](samples:akka-sample-fsm-scala)] +@java[@extref[FSM example project](samples:akka-samples-fsm-java)] +@scala[@extref[FSM example project](samples:akka-samples-fsm-scala)] is an example project that can be downloaded, and with instructions of how to run. This project contains a Dining Hakkers sample illustrating how to model a Finite State Machine (FSM) with actors. diff --git a/akka-docs/src/main/paradox/typed/persistence.md b/akka-docs/src/main/paradox/typed/persistence.md index 1f998f1597..bf6d9837bb 100644 --- a/akka-docs/src/main/paradox/typed/persistence.md +++ b/akka-docs/src/main/paradox/typed/persistence.md @@ -646,18 +646,18 @@ reference documentation of the chosen plugin. ## Example project -@java[@extref[Persistence example project](samples:akka-sample-persistence-java)] -@scala[@extref[Persistence example project](samples:akka-sample-persistence-scala)] +@java[@extref[Persistence example project](samples:akka-samples-persistence-java)] +@scala[@extref[Persistence example project](samples:akka-samples-persistence-scala)] is an example project that can be downloaded, and with instructions of how to run. This project contains a Shopping Cart sample illustrating how to use Akka Persistence. The Shopping Cart sample is expanded further in the -@java[@extref[CQRS example project](samples:akka-sample-cqrs-java)] -@scala[@extref[CQRS example project](samples:akka-sample-cqrs-scala)] +@java[@extref[CQRS example project](samples:akka-samples-cqrs-java)] +@scala[@extref[CQRS example project](samples:akka-samples-cqrs-scala)] sample. In that sample the events are tagged to be consumed by even processors to build other representations from the events, or publish the events to other services. -@java[@extref[Multi-DC Persistence example project](samples:akka-sample-persistence-dc-java)] -@scala[@extref[Multi-DC Persistence example project](samples:akka-sample-persistence-dc-scala)] +@java[@extref[Multi-DC Persistence example project](samples:akka-samples-persistence-dc-java)] +@scala[@extref[Multi-DC Persistence example project](samples:akka-samples-persistence-dc-scala)] illustrates how to use Lightbend's [Multi-DC Persistence](https://doc.akka.io/docs/akka-enhancements/current/persistence-dc/index.html) with active-active persistent entities across data centers.