Remove mentions of Typed - replaces @@@note of classic/typed with an includes (#27617)
This commit is contained in:
Helena Edelson
GitHub
parent
d4ea22403b
commit
a83c14b9aa
22 changed files with 44 additions and 189 deletions
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,7 @@
|
|||
# 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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
11
akka-docs/src/main/paradox/includes.md
Normal file
11
akka-docs/src/main/paradox/includes.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
|
||||
<!--- #actor-api --->
|
||||
@@@ 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).
|
||||
|
||||
@@@
|
||||
<!--- #actor-api --->
|
||||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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 }
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue