From a83c14b9aa4b038756bcbe1016388916b45638d0 Mon Sep 17 00:00:00 2001 From: Helena Edelson Date: Tue, 3 Sep 2019 13:23:47 -0700 Subject: [PATCH] Remove mentions of Typed - replaces @@@note of classic/typed with an includes (#27617) --- akka-docs/src/main/paradox/actors.md | 11 +---------- akka-docs/src/main/paradox/cluster-client.md | 10 +--------- akka-docs/src/main/paradox/cluster-routing.md | 10 +--------- akka-docs/src/main/paradox/cluster-sharding.md | 12 ++---------- akka-docs/src/main/paradox/cluster-singleton.md | 10 +--------- akka-docs/src/main/paradox/dispatchers.md | 12 ++---------- akka-docs/src/main/paradox/distributed-data.md | 14 +++----------- akka-docs/src/main/paradox/distributed-pub-sub.md | 12 ++---------- akka-docs/src/main/paradox/fault-tolerance.md | 12 ++---------- akka-docs/src/main/paradox/fsm.md | 10 +--------- akka-docs/src/main/paradox/includes.md | 11 +++++++++++ akka-docs/src/main/paradox/index-actors.md | 11 +---------- akka-docs/src/main/paradox/index-classic.md | 9 +-------- akka-docs/src/main/paradox/index-cluster.md | 10 +--------- akka-docs/src/main/paradox/index-network.md | 10 +--------- akka-docs/src/main/paradox/mailboxes.md | 12 ++---------- akka-docs/src/main/paradox/persistence-fsm.md | 9 +-------- akka-docs/src/main/paradox/persistence.md | 10 +--------- akka-docs/src/main/paradox/routing.md | 10 +--------- akka-docs/src/main/paradox/scheduler.md | 12 ++---------- akka-docs/src/main/paradox/testing.md | 10 +--------- build.sbt | 6 +++++- 22 files changed, 44 insertions(+), 189 deletions(-) create mode 100644 akka-docs/src/main/paradox/includes.md diff --git a/akka-docs/src/main/paradox/actors.md b/akka-docs/src/main/paradox/actors.md index 5e1925c388..1c0bd2a5e8 100644 --- a/akka-docs/src/main/paradox/actors.md +++ b/akka-docs/src/main/paradox/actors.md @@ -1,15 +1,6 @@ # Classic Actors -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -For the new API see @ref[actors](typed/actors.md). - -@@@ +@@include[includes.md](includes.md) { #actor-api } ## Dependency diff --git a/akka-docs/src/main/paradox/cluster-client.md b/akka-docs/src/main/paradox/cluster-client.md index 376b222440..de72d531e0 100644 --- a/akka-docs/src/main/paradox/cluster-client.md +++ b/akka-docs/src/main/paradox/cluster-client.md @@ -1,16 +1,8 @@ # Classic Cluster Client -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - +@@include[includes.md](includes.md) { #actor-api } Instead of the cluster client we recommend Akka gRPC (FIXME https://github.com/akka/akka/issues/26175) -@@@ - ## Dependency To use Cluster Client, you must add the following dependency in your project: diff --git a/akka-docs/src/main/paradox/cluster-routing.md b/akka-docs/src/main/paradox/cluster-routing.md index 2c294cdac1..6571523f39 100644 --- a/akka-docs/src/main/paradox/cluster-routing.md +++ b/akka-docs/src/main/paradox/cluster-routing.md @@ -1,16 +1,8 @@ # Classic Cluster Aware Routers -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - +@@include[includes.md](includes.md) { #actor-api } For the new API 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. When a node becomes unreachable or leaves the cluster the routees of that node are diff --git a/akka-docs/src/main/paradox/cluster-sharding.md b/akka-docs/src/main/paradox/cluster-sharding.md index 56eb01efb1..4f0e7d24b3 100644 --- a/akka-docs/src/main/paradox/cluster-sharding.md +++ b/akka-docs/src/main/paradox/cluster-sharding.md @@ -1,15 +1,7 @@ # Classic Cluster Sharding -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -For the new API see @ref[cluster-sharding](typed/cluster-sharding.md). - -@@@ +@@include[includes.md](includes.md) { #actor-api } +For the new API 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 a4c35d702f..586ee7f145 100644 --- a/akka-docs/src/main/paradox/cluster-singleton.md +++ b/akka-docs/src/main/paradox/cluster-singleton.md @@ -1,16 +1,8 @@ # Classic Cluster Singleton -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - +@@include[includes.md](includes.md) { #actor-api } For the new API see @ref[cluster-singleton](typed/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/dispatchers.md b/akka-docs/src/main/paradox/dispatchers.md index 1b5303c15a..b953a7ae5d 100644 --- a/akka-docs/src/main/paradox/dispatchers.md +++ b/akka-docs/src/main/paradox/dispatchers.md @@ -1,15 +1,7 @@ # Classic Dispatchers -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -For the new API see @ref[Dispatchers](typed/dispatchers.md). - -@@@ +@@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). diff --git a/akka-docs/src/main/paradox/distributed-data.md b/akka-docs/src/main/paradox/distributed-data.md index 2d50e21ab0..3c7a11d685 100644 --- a/akka-docs/src/main/paradox/distributed-data.md +++ b/akka-docs/src/main/paradox/distributed-data.md @@ -1,16 +1,8 @@ # Classic Distributed Data -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -For the new API see @ref[distributed-data](typed/distributed-data.md). - -@@@ - +@@include[includes.md](includes.md) { #actor-api } +For the new API see @ref:[distributed-data](typed/distributed-data.md). + ## Dependency To use Akka Distributed Data, you must add the following dependency in your project: diff --git a/akka-docs/src/main/paradox/distributed-pub-sub.md b/akka-docs/src/main/paradox/distributed-pub-sub.md index 7b60d25fa1..45eb81bc31 100644 --- a/akka-docs/src/main/paradox/distributed-pub-sub.md +++ b/akka-docs/src/main/paradox/distributed-pub-sub.md @@ -1,15 +1,7 @@ # Classic Distributed Publish Subscribe in Cluster -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -For the new API see FIXME https://github.com/akka/akka/issues/26338 - -@@@ +@@include[includes.md](includes.md) { #actor-api } +For the new API see FIXME https://github.com/akka/akka/issues/26338. ## Dependency diff --git a/akka-docs/src/main/paradox/fault-tolerance.md b/akka-docs/src/main/paradox/fault-tolerance.md index f3fa98ca7f..1be9003235 100644 --- a/akka-docs/src/main/paradox/fault-tolerance.md +++ b/akka-docs/src/main/paradox/fault-tolerance.md @@ -1,15 +1,7 @@ # Classic Fault Tolerance -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -For the new API see @ref[fault tolerance](typed/fault-tolerance.md). - -@@@ +@@include[includes.md](includes.md) { #actor-api } +For the new API 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 b2086acb60..c586cf2730 100644 --- a/akka-docs/src/main/paradox/fsm.md +++ b/akka-docs/src/main/paradox/fsm.md @@ -1,16 +1,8 @@ # Classic FSM -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - +@@include[includes.md](includes.md) { #actor-api } For the new API see @ref[fsm](typed/fsm.md). -@@@ - ## Dependency To use Finite State Machine actors, you must add the following dependency in your project: diff --git a/akka-docs/src/main/paradox/includes.md b/akka-docs/src/main/paradox/includes.md new file mode 100644 index 0000000000..8157933226 --- /dev/null +++ b/akka-docs/src/main/paradox/includes.md @@ -0,0 +1,11 @@ + + +@@@ note + +Akka Classic pertains to the original Actor APIs, which have been improved by more type safe and guided Actor APIs. +Akka Classic is still fully supported and existing applications can continue to use the classic APIs. It is also +possible to use the new Actor APIs together with classic actors in the same ActorSystem, see @ref:[coexistence](typed/coexisting.md). +For new projects we recommend using @ref:[the new Actor API](typed/actors.md). + +@@@ + \ No newline at end of file diff --git a/akka-docs/src/main/paradox/index-actors.md b/akka-docs/src/main/paradox/index-actors.md index e9b5d178c6..e4425384fd 100644 --- a/akka-docs/src/main/paradox/index-actors.md +++ b/akka-docs/src/main/paradox/index-actors.md @@ -1,15 +1,6 @@ # Classic Actors -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -For the new API see @ref[Actors](typed/actors.md). - -@@@ +@@include[includes.md](includes.md) { #actor-api } ## Dependency diff --git a/akka-docs/src/main/paradox/index-classic.md b/akka-docs/src/main/paradox/index-classic.md index 37f5a28251..df16413b6a 100644 --- a/akka-docs/src/main/paradox/index-classic.md +++ b/akka-docs/src/main/paradox/index-classic.md @@ -1,13 +1,6 @@ # Akka Classic -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -@@@ +@@include[includes.md](includes.md) { #actor-api } @@toc { depth=2 } diff --git a/akka-docs/src/main/paradox/index-cluster.md b/akka-docs/src/main/paradox/index-cluster.md index 468fe05a0f..08911ebf69 100644 --- a/akka-docs/src/main/paradox/index-cluster.md +++ b/akka-docs/src/main/paradox/index-cluster.md @@ -1,16 +1,8 @@ # Classic Clustering -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - +@@include[includes.md](includes.md) { #actor-api } For the new API see @ref[Cluster](typed/index-cluster.md). -@@@ - @@toc { depth=2 } @@@ index diff --git a/akka-docs/src/main/paradox/index-network.md b/akka-docs/src/main/paradox/index-network.md index 33585222c7..f92efeee4a 100644 --- a/akka-docs/src/main/paradox/index-network.md +++ b/akka-docs/src/main/paradox/index-network.md @@ -1,16 +1,8 @@ # Classic Networking -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - +@@include[includes.md](includes.md) { #actor-api } FIXME https://github.com/akka/akka/issues/27263 -@@@ - @@toc { depth=2 } @@@ index diff --git a/akka-docs/src/main/paradox/mailboxes.md b/akka-docs/src/main/paradox/mailboxes.md index 1e282644f5..3eebfa8b42 100644 --- a/akka-docs/src/main/paradox/mailboxes.md +++ b/akka-docs/src/main/paradox/mailboxes.md @@ -1,15 +1,7 @@ # Classic Mailboxes -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -For the new API see (FIXME https://github.com/akka/akka/issues/27124). - -@@@ +@@include[includes.md](includes.md) { #actor-api } +For the new API see @ref:[mailboxes](typed/mailboxes.md). ## Dependency diff --git a/akka-docs/src/main/paradox/persistence-fsm.md b/akka-docs/src/main/paradox/persistence-fsm.md index d860a0e12b..8a72ec01f8 100644 --- a/akka-docs/src/main/paradox/persistence-fsm.md +++ b/akka-docs/src/main/paradox/persistence-fsm.md @@ -1,13 +1,6 @@ # Classic Persistent FSM -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -@@@ +@@include[includes.md](includes.md) { #actor-api } ## Dependency diff --git a/akka-docs/src/main/paradox/persistence.md b/akka-docs/src/main/paradox/persistence.md index 34ab18e792..8e5094a835 100644 --- a/akka-docs/src/main/paradox/persistence.md +++ b/akka-docs/src/main/paradox/persistence.md @@ -1,16 +1,8 @@ # Classic Persistence -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - +@@include[includes.md](includes.md) { #actor-api } For the new API see @ref[persistence](typed/persistence.md). -@@@ - ## Dependency To use Akka Persistence, you must add the following dependency in your project: diff --git a/akka-docs/src/main/paradox/routing.md b/akka-docs/src/main/paradox/routing.md index 2551e69fb8..4b57b64404 100644 --- a/akka-docs/src/main/paradox/routing.md +++ b/akka-docs/src/main/paradox/routing.md @@ -1,16 +1,8 @@ # Classic Routing -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - +@@include[includes.md](includes.md) { #actor-api } For the new API see @ref[routers](typed/routers.md). -@@@ - ## Dependency To use Routing, you must add the following dependency in your project: diff --git a/akka-docs/src/main/paradox/scheduler.md b/akka-docs/src/main/paradox/scheduler.md index d2bcec76c6..ad0c65a11c 100644 --- a/akka-docs/src/main/paradox/scheduler.md +++ b/akka-docs/src/main/paradox/scheduler.md @@ -1,15 +1,7 @@ # Classic Scheduler -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - -For the new API see @ref[typed scheduling](typed/interaction-patterns.md#typed-scheduling). - -@@@ +@@include[includes.md](includes.md) { #actor-api } +For the new API see @ref:[typed scheduling](typed/interaction-patterns.md#typed-scheduling). ## Dependency diff --git a/akka-docs/src/main/paradox/testing.md b/akka-docs/src/main/paradox/testing.md index d26ddc8e52..d3751c41b0 100644 --- a/akka-docs/src/main/paradox/testing.md +++ b/akka-docs/src/main/paradox/testing.md @@ -1,16 +1,8 @@ # Testing Classic Actors -@@@ note - -Akka Classic is the original Actor APIs, which have been improved by more type safe and guided Actor APIs, -known as Akka Typed. Akka Classic is still fully supported and existing applications can continue to use -the classic APIs. It is also possible to use Akka Typed together with classic actors within the same -ActorSystem, see @ref[coexistence](typed/coexisting.md). For new projects we recommend using the new Actor APIs. - +@@include[includes.md](includes.md) { #actor-api } For the new API see @ref[testing](typed/testing.md). -@@@ - ## Dependency To use Akka Testkit, you must add the following dependency in your project: diff --git a/build.sbt b/build.sbt index bd9f704837..7fa14e7742 100644 --- a/build.sbt +++ b/build.sbt @@ -239,7 +239,11 @@ lazy val docs = akkaModule("akka-docs") // Page that recommends Alpakka: "camel.html", // TODO seems like an orphan? - "fault-tolerance-sample.html" + "fault-tolerance-sample.html", + // FIXME https://github.com/lightbend/paradox/issues/350 + // Links in a snippet are interpreted relative to the page the snippet is included in, + // instead of relative to the place where the snippet is declared. + "includes.html" ), resolvers += Resolver.jcenterRepo, apidocRootPackage := "akka",