From 8d19962dc89b83ba587f881e87c77fa124a353c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johan=20Andr=C3=A9n?= Date: Tue, 5 Nov 2019 20:06:32 +0100 Subject: [PATCH] Docs polish for 2.6.0 (#28125) * Plain text for back-link to classic pages instead of info box * No info breakouts up top in the actor intro page * No info boxes for the classic-version-of-the-page The info box takes too much attention and space * Re-order project info, update akka-paradox-sbt to get toggle --- akka-docs/src/main/paradox/actors.md | 6 +++--- akka-docs/src/main/paradox/cluster-client.md | 6 +++--- akka-docs/src/main/paradox/cluster-metrics.md | 6 +++--- akka-docs/src/main/paradox/cluster-sharding.md | 6 +++--- .../src/main/paradox/cluster-singleton.md | 6 +++--- akka-docs/src/main/paradox/cluster-usage.md | 6 +++--- akka-docs/src/main/paradox/coordination.md | 6 +++--- akka-docs/src/main/paradox/discovery/index.md | 6 +++--- .../src/main/paradox/distributed-pub-sub.md | 6 +++--- akka-docs/src/main/paradox/logging.md | 6 +++--- .../src/main/paradox/multi-node-testing.md | 6 +++--- akka-docs/src/main/paradox/persistence.md | 6 +++--- akka-docs/src/main/paradox/remoting.md | 6 +++--- akka-docs/src/main/paradox/stream/index.md | 6 +++--- akka-docs/src/main/paradox/testing.md | 6 +++--- .../src/main/paradox/typed/actor-discovery.md | 2 -- .../src/main/paradox/typed/actor-lifecycle.md | 2 -- akka-docs/src/main/paradox/typed/actors.md | 18 +++++++----------- akka-docs/src/main/paradox/typed/cluster-dc.md | 2 -- .../src/main/paradox/typed/cluster-sharding.md | 8 +++----- .../main/paradox/typed/cluster-singleton.md | 8 +++----- akka-docs/src/main/paradox/typed/cluster.md | 8 +++----- .../src/main/paradox/typed/dispatchers.md | 2 -- .../src/main/paradox/typed/distributed-data.md | 8 +++----- .../main/paradox/typed/distributed-pub-sub.md | 8 +++----- .../src/main/paradox/typed/fault-tolerance.md | 2 -- akka-docs/src/main/paradox/typed/fsm.md | 2 -- .../main/paradox/typed/interaction-patterns.md | 2 -- akka-docs/src/main/paradox/typed/logging.md | 2 -- akka-docs/src/main/paradox/typed/mailboxes.md | 2 -- .../main/paradox/typed/persistence-snapshot.md | 2 -- .../src/main/paradox/typed/persistence.md | 8 +++----- akka-docs/src/main/paradox/typed/routers.md | 2 -- akka-docs/src/main/paradox/typed/stash.md | 2 -- .../src/main/paradox/typed/testing-async.md | 2 -- .../src/main/paradox/typed/testing-sync.md | 2 -- akka-docs/src/main/paradox/typed/testing.md | 8 +++----- project/plugins.sbt | 2 +- 38 files changed, 74 insertions(+), 120 deletions(-) diff --git a/akka-docs/src/main/paradox/actors.md b/akka-docs/src/main/paradox/actors.md index cb5a219efc..a5b7f9baad 100644 --- a/akka-docs/src/main/paradox/actors.md +++ b/akka-docs/src/main/paradox/actors.md @@ -2,9 +2,7 @@ @@include[includes.md](includes.md) { #actor-api } -@@project-info{ projectId="akka-actor" } - -## Dependency +## Module info To use Classic Actors, add the following dependency in your project: @@ -14,6 +12,8 @@ To use Classic Actors, add the following dependency in your project: version="$akka.version$" } +@@project-info{ projectId="akka-actor" } + ## Introduction The [Actor Model](http://en.wikipedia.org/wiki/Actor_model) provides a higher level of abstraction for writing concurrent diff --git a/akka-docs/src/main/paradox/cluster-client.md b/akka-docs/src/main/paradox/cluster-client.md index 31227040ef..37d737f167 100644 --- a/akka-docs/src/main/paradox/cluster-client.md +++ b/akka-docs/src/main/paradox/cluster-client.md @@ -9,9 +9,7 @@ It is not advised to build new applications with Cluster Client, and existing us @@include[includes.md](includes.md) { #actor-api } -@@project-info{ projectId="akka-cluster-tools" } - -## Dependency +## Module info To use Cluster Client, you must add the following dependency in your project: @@ -21,6 +19,8 @@ To use Cluster Client, you must add the following dependency in your project: version=$akka.version$ } +@@project-info{ projectId="akka-cluster-tools" } + ## Introduction An actor system that is not part of the cluster can communicate with actors diff --git a/akka-docs/src/main/paradox/cluster-metrics.md b/akka-docs/src/main/paradox/cluster-metrics.md index ce47eadebd..78072cc132 100644 --- a/akka-docs/src/main/paradox/cluster-metrics.md +++ b/akka-docs/src/main/paradox/cluster-metrics.md @@ -1,8 +1,6 @@ # Classic Cluster Metrics Extension -@@project-info{ projectId="akka-cluster-metrics" } - -## Dependency +## Module info To use Cluster Metrics Extension, you must add the following dependency in your project: @@ -19,6 +17,8 @@ and add the following configuration stanza to your `application.conf` akka.extensions = [ "akka.cluster.metrics.ClusterMetricsExtension" ] ``` +@@project-info{ projectId="akka-cluster-metrics" } + ## Introduction diff --git a/akka-docs/src/main/paradox/cluster-sharding.md b/akka-docs/src/main/paradox/cluster-sharding.md index 4094689291..896e7a4e0b 100644 --- a/akka-docs/src/main/paradox/cluster-sharding.md +++ b/akka-docs/src/main/paradox/cluster-sharding.md @@ -3,9 +3,7 @@ @@include[includes.md](includes.md) { #actor-api } For the full documentation of this feature and for new projects see @ref:[Cluster Sharding](typed/cluster-sharding.md). -@@project-info{ projectId="akka-cluster-sharding" } - -## Dependency +## Module info To use Cluster Sharding, you must add the following dependency in your project: @@ -15,6 +13,8 @@ To use Cluster Sharding, you must add the following dependency in your project: version=$akka.version$ } +@@project-info{ projectId="akka-cluster-sharding" } + ## Sample project You can look at the diff --git a/akka-docs/src/main/paradox/cluster-singleton.md b/akka-docs/src/main/paradox/cluster-singleton.md index 7ac03eef8d..2b49211696 100644 --- a/akka-docs/src/main/paradox/cluster-singleton.md +++ b/akka-docs/src/main/paradox/cluster-singleton.md @@ -3,9 +3,7 @@ @@include[includes.md](includes.md) { #actor-api } For the full documentation of this feature and for new projects see @ref:[Cluster Singleton](typed/cluster-singleton.md). -@@project-info{ projectId="akka-cluster-tools" } - -## Dependency +## Module info To use Cluster Singleton, you must add the following dependency in your project: @@ -15,6 +13,8 @@ To use Cluster Singleton, you must add the following dependency in your project: version=$akka.version$ } +@@project-info{ projectId="akka-cluster-tools" } + ## Introduction For the full documentation of this feature and for new projects see @ref:[Cluster Singleton - Introduction](typed/cluster-singleton.md#introduction). diff --git a/akka-docs/src/main/paradox/cluster-usage.md b/akka-docs/src/main/paradox/cluster-usage.md index e68c38d8aa..6719badc6b 100644 --- a/akka-docs/src/main/paradox/cluster-usage.md +++ b/akka-docs/src/main/paradox/cluster-usage.md @@ -19,9 +19,7 @@ recommendation if you don't have other preferences or constraints. @@@ -@@project-info{ projectId="akka-cluster" } - -## Dependency +## Modue info To use Akka Cluster add the following dependency in your project: @@ -31,6 +29,8 @@ To use Akka Cluster add the following dependency in your project: version="$akka.version$" } +@@project-info{ projectId="akka-cluster" } + ## Cluster samples To see what using Akka Cluster looks like in practice, see the diff --git a/akka-docs/src/main/paradox/coordination.md b/akka-docs/src/main/paradox/coordination.md index db229bc70d..d1dcfb5685 100644 --- a/akka-docs/src/main/paradox/coordination.md +++ b/akka-docs/src/main/paradox/coordination.md @@ -5,9 +5,7 @@ project.description: A distributed lock with Akka Coordination using a pluggable Akka Coordination is a set of tools for distributed coordination. -@@project-info{ projectId="akka-coordination" } - -## Dependency +## Module info @@dependency[sbt,Gradle,Maven] { group="com.typesafe.akka" @@ -15,6 +13,8 @@ Akka Coordination is a set of tools for distributed coordination. version="$akka.version$" } +@@project-info{ projectId="akka-coordination" } + ## Lease The lease is a pluggable API for a distributed lock. diff --git a/akka-docs/src/main/paradox/discovery/index.md b/akka-docs/src/main/paradox/discovery/index.md index 725f25763f..5fb4cf93b8 100644 --- a/akka-docs/src/main/paradox/discovery/index.md +++ b/akka-docs/src/main/paradox/discovery/index.md @@ -31,9 +31,7 @@ See @ref:[Migration hints](#migrating-from-akka-management-discovery-before-1-0- @@@ -@@project-info{ projectId="akka-discovery" } - -## Dependency +## Module info @@dependency[sbt,Gradle,Maven] { group="com.typesafe.akka" @@ -41,6 +39,8 @@ See @ref:[Migration hints](#migrating-from-akka-management-discovery-before-1-0- version="$akka.version$" } +@@project-info{ projectId="akka-discovery" } + ## How it works Loading the extension: diff --git a/akka-docs/src/main/paradox/distributed-pub-sub.md b/akka-docs/src/main/paradox/distributed-pub-sub.md index d0f22d9514..a5843ae525 100644 --- a/akka-docs/src/main/paradox/distributed-pub-sub.md +++ b/akka-docs/src/main/paradox/distributed-pub-sub.md @@ -3,9 +3,7 @@ @@include[includes.md](includes.md) { #actor-api } For the new API see FIXME https://github.com/akka/akka/issues/26338. -@@project-info{ projectId="akka-cluster-tools" } - -## Dependency +## Module info To use Distributed Publish Subscribe you must add the following dependency in your project: @@ -15,6 +13,8 @@ To use Distributed Publish Subscribe you must add the following dependency in yo version="$akka.version$" } +@@project-info{ projectId="akka-cluster-tools" } + ## Introduction How do I send a message to an actor without knowing which node it is running on? diff --git a/akka-docs/src/main/paradox/logging.md b/akka-docs/src/main/paradox/logging.md index 48548c6a65..d957b9232c 100644 --- a/akka-docs/src/main/paradox/logging.md +++ b/akka-docs/src/main/paradox/logging.md @@ -3,9 +3,7 @@ @@include[includes.md](includes.md) { #actor-api } For the new API see @ref[Logging](typed/logging.md). -@@project-info{ projectId="akka-slf4j" } - -## Dependency +## Module info To use Logging, you must at least use the Akka actors dependency in your project, and will most likely want to configure logging via the SLF4J module (@ref:[see below](#slf4j)). @@ -15,6 +13,8 @@ To use Logging, you must at least use the Akka actors dependency in your project version="$akka.version$" } +@@project-info{ projectId="akka-slf4j" } + ## Introduction Logging in Akka is not tied to a specific logging backend. By default diff --git a/akka-docs/src/main/paradox/multi-node-testing.md b/akka-docs/src/main/paradox/multi-node-testing.md index 7f423828eb..dd08aa4564 100644 --- a/akka-docs/src/main/paradox/multi-node-testing.md +++ b/akka-docs/src/main/paradox/multi-node-testing.md @@ -3,9 +3,7 @@ project.description: Multi node testing of distributed systems built with Akka. --- # Multi Node Testing -@@project-info{ projectId="akka-multi-node-testkit" } - -## Dependency +## Module info To use Multi Node Testing, you must add the following dependency in your project: @@ -15,6 +13,8 @@ To use Multi Node Testing, you must add the following dependency in your project version=$akka.version$ } +@@project-info{ projectId="akka-multi-node-testkit" } + ## Sample project You can look at the diff --git a/akka-docs/src/main/paradox/persistence.md b/akka-docs/src/main/paradox/persistence.md index 86853c3754..77575e60cf 100644 --- a/akka-docs/src/main/paradox/persistence.md +++ b/akka-docs/src/main/paradox/persistence.md @@ -6,9 +6,7 @@ project.description: Akka Persistence Classic, event sourcing with Akka, At-Leas @@include[includes.md](includes.md) { #actor-api } For the full documentation of this feature and for new projects see @ref:[persistence](typed/persistence.md). -@@project-info{ projectId="akka-persistence" } - -## Dependency +## Module info To use Akka Persistence, you must add the following dependency in your project: @@ -21,6 +19,8 @@ To use Akka Persistence, you must add the following dependency in your project: You also have to select journal plugin and optionally snapshot store plugin, see @ref:[Persistence Plugins](persistence-plugins.md). +@@project-info{ projectId="akka-persistence" } + ## Sample project You can look at the diff --git a/akka-docs/src/main/paradox/remoting.md b/akka-docs/src/main/paradox/remoting.md index 430d0e2b6d..393c560f66 100644 --- a/akka-docs/src/main/paradox/remoting.md +++ b/akka-docs/src/main/paradox/remoting.md @@ -20,9 +20,7 @@ such as [HTTP](https://doc.akka.io/docs/akka-http/current/), @@@ -@@project-info{ projectId="akka-remote" } - -## Dependency +## Module info To use Akka Remoting, you must add the following dependency in your project: @@ -32,6 +30,8 @@ To use Akka Remoting, you must add the following dependency in your project: version=$akka.version$ } +@@project-info{ projectId="akka-remote" } + Classic remoting depends on Netty. This needs to be explicitly added as a dependency so that users not using classic remoting do not have to have Netty on the classpath: diff --git a/akka-docs/src/main/paradox/stream/index.md b/akka-docs/src/main/paradox/stream/index.md index 115791ef5f..88534ccf8e 100644 --- a/akka-docs/src/main/paradox/stream/index.md +++ b/akka-docs/src/main/paradox/stream/index.md @@ -3,9 +3,7 @@ project.description: An intuitive and safe way to do asynchronous, non-blocking --- # Streams -@@project-info{ projectId="akka-stream" } - -## Dependency +## Module info To use Akka Streams, add the module to your project: @@ -15,6 +13,8 @@ To use Akka Streams, add the module to your project: version="$akka.version$" } +@@project-info{ projectId="akka-stream" } + @@toc { depth=2 } @@@ index diff --git a/akka-docs/src/main/paradox/testing.md b/akka-docs/src/main/paradox/testing.md index 83b18a4228..712d53db5c 100644 --- a/akka-docs/src/main/paradox/testing.md +++ b/akka-docs/src/main/paradox/testing.md @@ -3,9 +3,7 @@ @@include[includes.md](includes.md) { #actor-api } For the new API see @ref[testing](typed/testing.md). -@@project-info{ projectId="akka-testkit" } - -## Dependency +## Module info To use Akka Testkit, you must add the following dependency in your project: @@ -16,6 +14,8 @@ To use Akka Testkit, you must add the following dependency in your project: scope="test" } +@@project-info{ projectId="akka-testkit" } + ## Introduction As with any piece of software, automated tests are a very important part of the diff --git a/akka-docs/src/main/paradox/typed/actor-discovery.md b/akka-docs/src/main/paradox/typed/actor-discovery.md index f6b9c61d58..7555ae3de7 100644 --- a/akka-docs/src/main/paradox/typed/actor-discovery.md +++ b/akka-docs/src/main/paradox/typed/actor-discovery.md @@ -1,8 +1,6 @@ # Actor discovery -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Actors](../actors.md#actorselection). -@@@ ## Dependency diff --git a/akka-docs/src/main/paradox/typed/actor-lifecycle.md b/akka-docs/src/main/paradox/typed/actor-lifecycle.md index b9a70bcb1b..512c584cdb 100644 --- a/akka-docs/src/main/paradox/typed/actor-lifecycle.md +++ b/akka-docs/src/main/paradox/typed/actor-lifecycle.md @@ -3,9 +3,7 @@ project.description: The Akka Actor lifecycle. --- # Actor lifecycle -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Actors](../actors.md). -@@@ ## Dependency diff --git a/akka-docs/src/main/paradox/typed/actors.md b/akka-docs/src/main/paradox/typed/actors.md index 8f652f4194..b89ee18d91 100644 --- a/akka-docs/src/main/paradox/typed/actors.md +++ b/akka-docs/src/main/paradox/typed/actors.md @@ -3,19 +3,9 @@ project.description: The Actor model, managing internal state and changing behav --- # Introduction to Actors -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Actors](../actors.md). -@@@ -@@@ note -Both the Java and Scala DSLs of Akka modules bundled in the same JAR. For a smooth development experience, -when using an IDE such as Eclipse or IntelliJ, you can disable the auto-importer from suggesting `javadsl` -imports when working in Scala, or viceversa. See @ref:[IDE Tips](../additional/ide.md). -@@@ - -@@project-info{ projectId="akka-actor-typed" } - -## Dependency +## Module info To use Akka Actors, add the following dependency in your project: @@ -25,6 +15,12 @@ To use Akka Actors, add the following dependency in your project: version=$akka.version$ } +Both the Java and Scala DSLs of Akka modules bundled in the same JAR. For a smooth development experience, +when using an IDE such as Eclipse or IntelliJ, you can disable the auto-importer from suggesting `javadsl` +imports when working in Scala, or viceversa. See @ref:[IDE Tips](../additional/ide.md). + +@@project-info{ projectId="akka-actor-typed" } + ## Akka Actors The [Actor Model](http://en.wikipedia.org/wiki/Actor_model) provides a higher level of abstraction for writing concurrent diff --git a/akka-docs/src/main/paradox/typed/cluster-dc.md b/akka-docs/src/main/paradox/typed/cluster-dc.md index ecba52e358..315c1e4c8c 100644 --- a/akka-docs/src/main/paradox/typed/cluster-dc.md +++ b/akka-docs/src/main/paradox/typed/cluster-dc.md @@ -1,8 +1,6 @@ # Multi-DC Cluster -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Multi-DC Cluster](../cluster-dc.md) -@@@ This chapter describes how @ref[Akka Cluster](cluster.md) can be used across multiple data centers, availability zones or regions. diff --git a/akka-docs/src/main/paradox/typed/cluster-sharding.md b/akka-docs/src/main/paradox/typed/cluster-sharding.md index 31d2f3b26a..fac56d9992 100644 --- a/akka-docs/src/main/paradox/typed/cluster-sharding.md +++ b/akka-docs/src/main/paradox/typed/cluster-sharding.md @@ -3,13 +3,9 @@ project.description: Shard a clustered compute process across the network with l --- # Cluster Sharding -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Cluster Sharding](../cluster-sharding.md) -@@@ -@@project-info{ projectId="akka-cluster-sharding-typed" } - -## Dependency +## Module info To use Akka Cluster Sharding, you must add the following dependency in your project: @@ -19,6 +15,8 @@ To use Akka Cluster Sharding, you must add the following dependency in your proj version=$akka.version$ } +@@project-info{ projectId="akka-cluster-sharding-typed" } + ## Introduction Cluster sharding is useful when you need to distribute actors across several nodes in the cluster and want to diff --git a/akka-docs/src/main/paradox/typed/cluster-singleton.md b/akka-docs/src/main/paradox/typed/cluster-singleton.md index 2195c85537..65c004743d 100644 --- a/akka-docs/src/main/paradox/typed/cluster-singleton.md +++ b/akka-docs/src/main/paradox/typed/cluster-singleton.md @@ -1,12 +1,8 @@ # Cluster Singleton -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Cluster Singleton](../cluster-singleton.md). -@@@ -@@project-info{ projectId="akka-cluster-typed" } - -## Dependency +## Module info To use Cluster Singleton, you must add the following dependency in your project: @@ -16,6 +12,8 @@ To use Cluster Singleton, you must add the following dependency in your project: version=$akka.version$ } +@@project-info{ projectId="akka-cluster-typed" } + ## Introduction For some use cases it is convenient and sometimes also mandatory to ensure that diff --git a/akka-docs/src/main/paradox/typed/cluster.md b/akka-docs/src/main/paradox/typed/cluster.md index 0e7c4c3a18..e7045ce49a 100644 --- a/akka-docs/src/main/paradox/typed/cluster.md +++ b/akka-docs/src/main/paradox/typed/cluster.md @@ -13,17 +13,13 @@ For specific documentation topics see: * @ref:[Rolling Updates](../additional/rolling-updates.md) * @ref:[Operating, Managing, Observability](../additional/operations.md) -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Cluster](../cluster-usage.md). -@@@ You have to enable @ref:[serialization](../serialization.md) to send messages between ActorSystems (nodes) in the Cluster. @ref:[Serialization with Jackson](../serialization-jackson.md) is a good choice in many cases, and our recommendation if you don't have other preferences or constraints. -@@project-info{ projectId="akka-cluster-typed" } - -## Dependency +## Module info To use Akka Cluster add the following dependency in your project: @@ -33,6 +29,8 @@ To use Akka Cluster add the following dependency in your project: version=$akka.version$ } +@@project-info{ projectId="akka-cluster-typed" } + ## Cluster samples To see what using Akka Cluster looks like in practice, see the diff --git a/akka-docs/src/main/paradox/typed/dispatchers.md b/akka-docs/src/main/paradox/typed/dispatchers.md index 5d322af4d7..fb88224c40 100644 --- a/akka-docs/src/main/paradox/typed/dispatchers.md +++ b/akka-docs/src/main/paradox/typed/dispatchers.md @@ -3,9 +3,7 @@ project.description: Akka dispatchers and how to choose the right ones. --- # Dispatchers -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Dispatchers](../dispatchers.md). -@@@ ## Dependency diff --git a/akka-docs/src/main/paradox/typed/distributed-data.md b/akka-docs/src/main/paradox/typed/distributed-data.md index d3c197c7ce..06ae13b438 100644 --- a/akka-docs/src/main/paradox/typed/distributed-data.md +++ b/akka-docs/src/main/paradox/typed/distributed-data.md @@ -3,13 +3,9 @@ project.description: Share data between nodes and perform updates without coordi --- # Distributed Data -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Distributed Data](../distributed-data.md). -@@@ -@@project-info{ projectId="akka-cluster-typed" } - -## Dependency +## Module info To use Akka Cluster Distributed Data, you must add the following dependency in your project: @@ -19,6 +15,8 @@ To use Akka Cluster Distributed Data, you must add the following dependency in y version=$akka.version$ } +@@project-info{ projectId="akka-cluster-typed" } + ## Introduction *Akka Distributed Data* is useful when you need to share data between nodes in an diff --git a/akka-docs/src/main/paradox/typed/distributed-pub-sub.md b/akka-docs/src/main/paradox/typed/distributed-pub-sub.md index 16191f4823..196cec581b 100644 --- a/akka-docs/src/main/paradox/typed/distributed-pub-sub.md +++ b/akka-docs/src/main/paradox/typed/distributed-pub-sub.md @@ -1,13 +1,9 @@ # Distributed Publish Subscribe in Cluster -@@@ note For the Akka Classic documentation of this feature see [Classic Distributed Publish Subscribe](../distributed-pub-sub.md). Classic Pub Sub can be used by leveraging the `.toClassic` adapters until @github[#26338](#26338). -@@@ -@@project-info{ projectId="akka-cluster-typed" } - -## Dependency +## Module info Until the new Distributed Publish Subscribe API, see @github[#26338](#26338), you can use Classic Distributed Publish Subscribe @@ -27,6 +23,8 @@ Add the new Cluster API if you don't already have it in an existing Cluster appl version=$akka.version$ } +@@project-info{ projectId="akka-cluster-typed" } + ## Sample project Until @github[#26338](#26338), [this simple example]($github.base_url$/akka-cluster-typed/src/test/scala/docs/akka/cluster/typed/DistributedPubSubExample.scala) shows how to use diff --git a/akka-docs/src/main/paradox/typed/fault-tolerance.md b/akka-docs/src/main/paradox/typed/fault-tolerance.md index e0a5070463..4378e0a260 100644 --- a/akka-docs/src/main/paradox/typed/fault-tolerance.md +++ b/akka-docs/src/main/paradox/typed/fault-tolerance.md @@ -1,8 +1,6 @@ # Fault Tolerance -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Fault Tolerance](../fault-tolerance.md). -@@@ When an actor throws an unexpected exception, a failure, while processing a message or during initialization, the actor will by default be stopped. diff --git a/akka-docs/src/main/paradox/typed/fsm.md b/akka-docs/src/main/paradox/typed/fsm.md index 676000aabb..97db0a46c5 100644 --- a/akka-docs/src/main/paradox/typed/fsm.md +++ b/akka-docs/src/main/paradox/typed/fsm.md @@ -3,9 +3,7 @@ project.description: Finite State Machines (FSM) with Akka Actors. --- # Behaviors as finite state machines -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic FSM](../fsm.md). -@@@ An actor can be used to model a Finite State Machine (FSM). diff --git a/akka-docs/src/main/paradox/typed/interaction-patterns.md b/akka-docs/src/main/paradox/typed/interaction-patterns.md index e6c5d2b7d1..cba90a1303 100644 --- a/akka-docs/src/main/paradox/typed/interaction-patterns.md +++ b/akka-docs/src/main/paradox/typed/interaction-patterns.md @@ -1,8 +1,6 @@ # Interaction Patterns -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Actors](../actors.md). -@@@ ## Dependency diff --git a/akka-docs/src/main/paradox/typed/logging.md b/akka-docs/src/main/paradox/typed/logging.md index ea8f081cdb..62b0be9ed3 100644 --- a/akka-docs/src/main/paradox/typed/logging.md +++ b/akka-docs/src/main/paradox/typed/logging.md @@ -3,9 +3,7 @@ project.description: Logging options with Akka. --- # Logging -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Logging](../logging.md). -@@@ ## Dependency diff --git a/akka-docs/src/main/paradox/typed/mailboxes.md b/akka-docs/src/main/paradox/typed/mailboxes.md index d21c7f5cc5..c95c13347b 100644 --- a/akka-docs/src/main/paradox/typed/mailboxes.md +++ b/akka-docs/src/main/paradox/typed/mailboxes.md @@ -1,8 +1,6 @@ # Mailboxes -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Mailboxes](../mailboxes.md). -@@@ ## Dependency diff --git a/akka-docs/src/main/paradox/typed/persistence-snapshot.md b/akka-docs/src/main/paradox/typed/persistence-snapshot.md index dd5ab60f1b..6bdba2c68c 100644 --- a/akka-docs/src/main/paradox/typed/persistence-snapshot.md +++ b/akka-docs/src/main/paradox/typed/persistence-snapshot.md @@ -3,9 +3,7 @@ project.description: Append only event logs, snapshots and recovery with Akka ev --- # Snapshotting -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Akka Persistence](../persistence.md). -@@@ ## Snapshots diff --git a/akka-docs/src/main/paradox/typed/persistence.md b/akka-docs/src/main/paradox/typed/persistence.md index 18dc2caf27..9fb367ec74 100644 --- a/akka-docs/src/main/paradox/typed/persistence.md +++ b/akka-docs/src/main/paradox/typed/persistence.md @@ -3,13 +3,9 @@ project.description: Event Sourcing with Akka Persistence enables actors to pers --- # Event Sourcing -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Akka Persistence](../persistence.md). -@@@ -@@project-info{ projectId="akka-persistence-typed" } - -## Dependency +## Module info To use Akka Persistence, add the module to your project: @@ -22,6 +18,8 @@ To use Akka Persistence, add the module to your project: You also have to select journal plugin and optionally snapshot store plugin, see @ref:[Persistence Plugins](../persistence-plugins.md). +@@project-info{ projectId="akka-persistence-typed" } + ## Introduction Akka Persistence enables stateful actors to persist their state so that it can be recovered when an actor diff --git a/akka-docs/src/main/paradox/typed/routers.md b/akka-docs/src/main/paradox/typed/routers.md index 03a9ae18d3..de189e5cd7 100644 --- a/akka-docs/src/main/paradox/typed/routers.md +++ b/akka-docs/src/main/paradox/typed/routers.md @@ -1,8 +1,6 @@ # Routers -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Routing](../routing.md). -@@@ ## Dependency diff --git a/akka-docs/src/main/paradox/typed/stash.md b/akka-docs/src/main/paradox/typed/stash.md index b34b45d793..2a7b77f7f8 100644 --- a/akka-docs/src/main/paradox/typed/stash.md +++ b/akka-docs/src/main/paradox/typed/stash.md @@ -1,8 +1,6 @@ # Stash -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Actors](../actors.md#stash). -@@@ ## Dependency diff --git a/akka-docs/src/main/paradox/typed/testing-async.md b/akka-docs/src/main/paradox/typed/testing-async.md index 12e4673a4f..1213c5efab 100644 --- a/akka-docs/src/main/paradox/typed/testing-async.md +++ b/akka-docs/src/main/paradox/typed/testing-async.md @@ -1,8 +1,6 @@ ## Asynchronous testing -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Testing](../testing.md). -@@@ Asynchronous testing uses a real @apidoc[akka.actor.typed.ActorSystem] that allows you to test your Actors in a more realistic environment. diff --git a/akka-docs/src/main/paradox/typed/testing-sync.md b/akka-docs/src/main/paradox/typed/testing-sync.md index 303dd301ad..ae9fb96f68 100644 --- a/akka-docs/src/main/paradox/typed/testing-sync.md +++ b/akka-docs/src/main/paradox/typed/testing-sync.md @@ -1,8 +1,6 @@ ## Synchronous behavior testing -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Testing](../testing.md). -@@@ The `BehaviorTestKit` provides a very nice way of unit testing a `Behavior` in a deterministic way, but it has some limitations to be aware of. diff --git a/akka-docs/src/main/paradox/typed/testing.md b/akka-docs/src/main/paradox/typed/testing.md index 62959ef6e1..17c2770d49 100644 --- a/akka-docs/src/main/paradox/typed/testing.md +++ b/akka-docs/src/main/paradox/typed/testing.md @@ -1,12 +1,8 @@ # Testing -@@@ note For the Akka Classic documentation of this feature see @ref:[Classic Testing](../testing.md). -@@@ -@@project-info{ projectId="akka-actor-testkit-typed" } - -## Dependency +## Module info To use Actor TestKit add the module to your project: @@ -30,6 +26,8 @@ We recommend using Akka TestKit with ScalaTest: @@@ +@@project-info{ projectId="akka-actor-testkit-typed" } + ## Introduction Testing can either be done asynchronously using a real @apidoc[akka.actor.typed.ActorSystem] or synchronously on the testing thread using the diff --git a/project/plugins.sbt b/project/plugins.sbt index 06b9c82923..9da596ca9c 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -20,7 +20,7 @@ addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.3.7") addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.4.1") addSbtPlugin("io.spray" % "sbt-boilerplate" % "0.6.1") addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.4.2") -addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.25") +addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.26") addSbtPlugin("com.lightbend" % "sbt-whitesource" % "0.1.17") addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.2.0") // for maintenance of copyright file header addSbtPlugin("com.hpe.sbt" % "sbt-pull-request-validator" % "1.0.0")