From e8e7ac020f0bee81bf7c51390dce460ffe59da95 Mon Sep 17 00:00:00 2001 From: Helena Edelson Date: Thu, 26 Sep 2019 14:36:02 +0200 Subject: [PATCH] Cross link also from Typed doc pages to Classic (#27784) --- akka-docs/src/main/paradox/cluster-routing.md | 2 +- akka-docs/src/main/paradox/cluster-sharding.md | 2 +- akka-docs/src/main/paradox/cluster-singleton.md | 2 +- akka-docs/src/main/paradox/cluster-usage.md | 5 +++-- akka-docs/src/main/paradox/dispatchers.md | 4 +--- akka-docs/src/main/paradox/distributed-data.md | 2 +- akka-docs/src/main/paradox/fault-tolerance.md | 2 +- akka-docs/src/main/paradox/fsm.md | 2 +- akka-docs/src/main/paradox/mailboxes.md | 2 +- akka-docs/src/main/paradox/persistence.md | 2 +- akka-docs/src/main/paradox/routing.md | 2 +- akka-docs/src/main/paradox/typed/cluster-singleton.md | 6 ++++++ akka-docs/src/main/paradox/typed/cluster.md | 6 ++++-- akka-docs/src/main/paradox/typed/dispatchers.md | 6 ++++++ akka-docs/src/main/paradox/typed/distributed-data.md | 6 ++++++ akka-docs/src/main/paradox/typed/fault-tolerance.md | 6 ++++++ akka-docs/src/main/paradox/typed/fsm.md | 6 ++++++ akka-docs/src/main/paradox/typed/mailboxes.md | 6 ++++++ akka-docs/src/main/paradox/typed/persistence.md | 6 ++++++ akka-docs/src/main/paradox/typed/testing.md | 6 ++++++ 20 files changed, 65 insertions(+), 16 deletions(-) diff --git a/akka-docs/src/main/paradox/cluster-routing.md b/akka-docs/src/main/paradox/cluster-routing.md index 6571523f39..6cc0aa93a1 100644 --- a/akka-docs/src/main/paradox/cluster-routing.md +++ b/akka-docs/src/main/paradox/cluster-routing.md @@ -1,7 +1,7 @@ # Classic Cluster Aware Routers @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref[routers](typed/routers.md). +For the full documentation of this feature and for new projects see @ref:[routers](typed/routers.md). All @ref:[routers](routing.md) can be made aware of member nodes in the cluster, i.e. deploying new routees or looking up routees on nodes in the cluster. diff --git a/akka-docs/src/main/paradox/cluster-sharding.md b/akka-docs/src/main/paradox/cluster-sharding.md index 60ad4781b7..6cfc72b4ee 100644 --- a/akka-docs/src/main/paradox/cluster-sharding.md +++ b/akka-docs/src/main/paradox/cluster-sharding.md @@ -1,7 +1,7 @@ # Classic Cluster Sharding @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref:[Cluster Sharding](typed/cluster-sharding.md). +For the full documentation of this feature and for new projects see @ref:[Cluster Sharding](typed/cluster-sharding.md). ## Dependency diff --git a/akka-docs/src/main/paradox/cluster-singleton.md b/akka-docs/src/main/paradox/cluster-singleton.md index ac3358054b..a56eec010e 100644 --- a/akka-docs/src/main/paradox/cluster-singleton.md +++ b/akka-docs/src/main/paradox/cluster-singleton.md @@ -1,7 +1,7 @@ # Classic Cluster Singleton @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref[cluster-singleton](typed/cluster-singleton.md). +For the full documentation of this feature and for new projects see @ref:[Cluster Singleton](typed/cluster-singleton.md). ## Dependency diff --git a/akka-docs/src/main/paradox/cluster-usage.md b/akka-docs/src/main/paradox/cluster-usage.md index a866aa9242..341cc37364 100644 --- a/akka-docs/src/main/paradox/cluster-usage.md +++ b/akka-docs/src/main/paradox/cluster-usage.md @@ -1,6 +1,7 @@ # Classic Cluster Usage - -This document describes how to use Akka Cluster and the Cluster APIs using code samples. + +@@include[includes.md](includes.md) { #actor-api } +For the full documentation of this feature and for new projects see @ref:[Cluster](typed/cluster.md). For specific documentation topics see: * @ref:[Cluster Specification](typed/cluster-concepts.md) diff --git a/akka-docs/src/main/paradox/dispatchers.md b/akka-docs/src/main/paradox/dispatchers.md index b953a7ae5d..6530aa312c 100644 --- a/akka-docs/src/main/paradox/dispatchers.md +++ b/akka-docs/src/main/paradox/dispatchers.md @@ -1,9 +1,7 @@ # Classic Dispatchers @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref:[Dispatchers](typed/dispatchers.md). - -For more details on advanced dispatcher config and options, see @ref[Dispatchers](typed/dispatchers.md). +For the full documentation of this feature and for new projects see @ref:[Dispatchers](typed/dispatchers.md). ## Dependency diff --git a/akka-docs/src/main/paradox/distributed-data.md b/akka-docs/src/main/paradox/distributed-data.md index 1accdb4547..9ab4ee578e 100644 --- a/akka-docs/src/main/paradox/distributed-data.md +++ b/akka-docs/src/main/paradox/distributed-data.md @@ -1,7 +1,7 @@ # Classic Distributed Data @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref:[distributed-data](typed/distributed-data.md). +For the full documentation of this feature and for new projects see @ref:[Distributed Data](typed/distributed-data.md). ## Dependency diff --git a/akka-docs/src/main/paradox/fault-tolerance.md b/akka-docs/src/main/paradox/fault-tolerance.md index 1be9003235..f1d4245896 100644 --- a/akka-docs/src/main/paradox/fault-tolerance.md +++ b/akka-docs/src/main/paradox/fault-tolerance.md @@ -1,7 +1,7 @@ # Classic Fault Tolerance @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref:[fault tolerance](typed/fault-tolerance.md). +For the full documentation of this feature and for new projects see @ref:[fault tolerance](typed/fault-tolerance.md). ## Dependency diff --git a/akka-docs/src/main/paradox/fsm.md b/akka-docs/src/main/paradox/fsm.md index c586cf2730..cead847794 100644 --- a/akka-docs/src/main/paradox/fsm.md +++ b/akka-docs/src/main/paradox/fsm.md @@ -1,7 +1,7 @@ # Classic FSM @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref[fsm](typed/fsm.md). +For the full documentation of this feature and for new projects see @ref:[fsm](typed/fsm.md). ## Dependency diff --git a/akka-docs/src/main/paradox/mailboxes.md b/akka-docs/src/main/paradox/mailboxes.md index db03180a5d..946495ec29 100644 --- a/akka-docs/src/main/paradox/mailboxes.md +++ b/akka-docs/src/main/paradox/mailboxes.md @@ -1,7 +1,7 @@ # Classic Mailboxes @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref:[mailboxes](typed/mailboxes.md). +For the full documentation of this feature and for new projects see @ref:[mailboxes](typed/mailboxes.md). ## Dependency diff --git a/akka-docs/src/main/paradox/persistence.md b/akka-docs/src/main/paradox/persistence.md index 8e5094a835..52dec1f536 100644 --- a/akka-docs/src/main/paradox/persistence.md +++ b/akka-docs/src/main/paradox/persistence.md @@ -1,7 +1,7 @@ # Classic Persistence @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref[persistence](typed/persistence.md). +For the full documentation of this feature and for new projects see @ref:[persistence](typed/persistence.md). ## Dependency diff --git a/akka-docs/src/main/paradox/routing.md b/akka-docs/src/main/paradox/routing.md index 4b57b64404..b37662e115 100644 --- a/akka-docs/src/main/paradox/routing.md +++ b/akka-docs/src/main/paradox/routing.md @@ -1,7 +1,7 @@ # Classic Routing @@include[includes.md](includes.md) { #actor-api } -For the new API see @ref[routers](typed/routers.md). +For the full documentation of this feature and for new projects see @ref:[routers](typed/routers.md). ## Dependency diff --git a/akka-docs/src/main/paradox/typed/cluster-singleton.md b/akka-docs/src/main/paradox/typed/cluster-singleton.md index 3e780fbb3d..759e37895d 100644 --- a/akka-docs/src/main/paradox/typed/cluster-singleton.md +++ b/akka-docs/src/main/paradox/typed/cluster-singleton.md @@ -1,5 +1,11 @@ # Cluster Singleton +@@@ note + +For the Akka Classic documentation of this feature see @ref:[Classic Cluster Singleton](../cluster-singleton.md). + +@@@ + ## Dependency To use Cluster Singleton, you must add the following dependency in your project: diff --git a/akka-docs/src/main/paradox/typed/cluster.md b/akka-docs/src/main/paradox/typed/cluster.md index ab3163e718..5c18619345 100644 --- a/akka-docs/src/main/paradox/typed/cluster.md +++ b/akka-docs/src/main/paradox/typed/cluster.md @@ -12,12 +12,14 @@ For specific documentation topics see: @@@ 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 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. -@@@ - ## Dependency To use Akka Cluster add the following dependency in your project: diff --git a/akka-docs/src/main/paradox/typed/dispatchers.md b/akka-docs/src/main/paradox/typed/dispatchers.md index 2c2e0156cf..1d99ba634e 100644 --- a/akka-docs/src/main/paradox/typed/dispatchers.md +++ b/akka-docs/src/main/paradox/typed/dispatchers.md @@ -1,5 +1,11 @@ # Dispatchers +@@@ note + +For the Akka Classic documentation of this feature see @ref:[Classic Dispatchers](../dispatchers.md). + +@@@ + ## Dependency Dispatchers are part of core Akka, which means that they are part of the akka-actor-typed dependency: diff --git a/akka-docs/src/main/paradox/typed/distributed-data.md b/akka-docs/src/main/paradox/typed/distributed-data.md index a5918d9350..0029aec8de 100644 --- a/akka-docs/src/main/paradox/typed/distributed-data.md +++ b/akka-docs/src/main/paradox/typed/distributed-data.md @@ -1,5 +1,11 @@ # Distributed Data +@@@ note + +For the Akka Classic documentation of this feature see @ref:[Classic Distributed Data](../distributed-data.md). + +@@@ + ## Dependency To use Akka Cluster Distributed Data Typed, you must add the following dependency in your project: diff --git a/akka-docs/src/main/paradox/typed/fault-tolerance.md b/akka-docs/src/main/paradox/typed/fault-tolerance.md index 0b0cc6b87f..238c384180 100644 --- a/akka-docs/src/main/paradox/typed/fault-tolerance.md +++ b/akka-docs/src/main/paradox/typed/fault-tolerance.md @@ -1,5 +1,11 @@ # 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 232eaf8698..c6588850bf 100644 --- a/akka-docs/src/main/paradox/typed/fsm.md +++ b/akka-docs/src/main/paradox/typed/fsm.md @@ -1,5 +1,11 @@ # 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). To demonstrate this, consider an actor which shall receive and queue messages while they arrive in a burst and diff --git a/akka-docs/src/main/paradox/typed/mailboxes.md b/akka-docs/src/main/paradox/typed/mailboxes.md index 38bca9df26..4cddaa7366 100644 --- a/akka-docs/src/main/paradox/typed/mailboxes.md +++ b/akka-docs/src/main/paradox/typed/mailboxes.md @@ -1,5 +1,11 @@ # Mailboxes +@@@ note + +For the Akka Classic documentation of this feature see @ref:[Classic Mailboxes](../mailboxes.md). + +@@@ + ## Dependency Mailboxes are part of core Akka, which means that they are part of the akka-actor-typed dependency: diff --git a/akka-docs/src/main/paradox/typed/persistence.md b/akka-docs/src/main/paradox/typed/persistence.md index e6a017d797..16f26b879b 100644 --- a/akka-docs/src/main/paradox/typed/persistence.md +++ b/akka-docs/src/main/paradox/typed/persistence.md @@ -11,6 +11,12 @@ @@@ +@@@ note + +For the Akka Classic documentation of this feature see @ref:[Classic Akka Persistence](../persistence.md). + +@@@ + ## Dependency To use Akka Persistence Typed, add the module to your project: diff --git a/akka-docs/src/main/paradox/typed/testing.md b/akka-docs/src/main/paradox/typed/testing.md index 44fa788fb9..567dec1213 100644 --- a/akka-docs/src/main/paradox/typed/testing.md +++ b/akka-docs/src/main/paradox/typed/testing.md @@ -1,5 +1,11 @@ # Testing +@@@ note + +For the Akka Classic documentation of this feature see @ref:[Classic Testing](../testing.md). + +@@@ + ## Dependency To use Akka TestKit add the module to your project: