raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

Remove mentions of Typed - replaces @@@note of classic/typed with an includes (#27617)

Browse source
This commit is contained in:
Helena Edelson 2019-09-03 13:23:47 -07:00 • committed by GitHub
parent d4ea22403b
commit a83c14b9aa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 44 additions and 189 deletions
Download patch file Download diff file Expand all files Collapse all files

11
akka-docs/src/main/paradox/actors.md
View file

@ -1,15 +1,6 @@
# Classic Actors # Classic Actors
@@@ note @@include[includes.md](includes.md) { #actor-api }
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).
@@@
## Dependency ## Dependency

10
akka-docs/src/main/paradox/cluster-client.md
View file

@ -1,16 +1,8 @@
# Classic Cluster Client # Classic Cluster Client
@@@ note @@include[includes.md](includes.md) { #actor-api }
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.
Instead of the cluster client we recommend Akka gRPC (FIXME https://github.com/akka/akka/issues/26175) Instead of the cluster client we recommend Akka gRPC (FIXME https://github.com/akka/akka/issues/26175)
@@@
## Dependency ## Dependency
To use Cluster Client, you must add the following dependency in your project: To use Cluster Client, you must add the following dependency in your project:

10
akka-docs/src/main/paradox/cluster-routing.md
View file

@ -1,16 +1,8 @@
# Classic Cluster Aware Routers # Classic Cluster Aware Routers
@@@ note @@include[includes.md](includes.md) { #actor-api }
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[routers](typed/routers.md). 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. 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. 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 When a node becomes unreachable or leaves the cluster the routees of that node are

12
akka-docs/src/main/paradox/cluster-sharding.md
View file

@ -1,15 +1,7 @@
# Classic Cluster Sharding # Classic Cluster Sharding
@@@ note @@include[includes.md](includes.md) { #actor-api }
For the new API see @ref:[cluster-sharding](typed/cluster-sharding.md).
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).
@@@
## Dependency ## Dependency

10
akka-docs/src/main/paradox/cluster-singleton.md
View file

@ -1,16 +1,8 @@
# Classic Cluster Singleton # Classic Cluster Singleton
@@@ note @@include[includes.md](includes.md) { #actor-api }
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-singleton](typed/cluster-singleton.md). For the new API see @ref[cluster-singleton](typed/cluster-singleton.md).
@@@
## Dependency ## Dependency
To use Cluster Singleton, you must add the following dependency in your project: To use Cluster Singleton, you must add the following dependency in your project:

12
akka-docs/src/main/paradox/dispatchers.md
View file

@ -1,15 +1,7 @@
# Classic Dispatchers # Classic Dispatchers
@@@ note @@include[includes.md](includes.md) { #actor-api }
For the new API see @ref:[Dispatchers](typed/dispatchers.md).
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).
@@@
For more details on advanced dispatcher config and options, see @ref[Dispatchers](typed/dispatchers.md). For more details on advanced dispatcher config and options, see @ref[Dispatchers](typed/dispatchers.md).

12
akka-docs/src/main/paradox/distributed-data.md
View file

@ -1,15 +1,7 @@
# Classic Distributed Data # Classic Distributed Data
@@@ note @@include[includes.md](includes.md) { #actor-api }
For the new API see @ref:[distributed-data](typed/distributed-data.md).
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).
@@@
## Dependency ## Dependency

12
akka-docs/src/main/paradox/distributed-pub-sub.md
View file

@ -1,15 +1,7 @@
# Classic Distributed Publish Subscribe in Cluster # Classic Distributed Publish Subscribe in Cluster
@@@ note @@include[includes.md](includes.md) { #actor-api }
For the new API see FIXME https://github.com/akka/akka/issues/26338.
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
@@@
## Dependency ## Dependency

12
akka-docs/src/main/paradox/fault-tolerance.md
View file

@ -1,15 +1,7 @@
# Classic Fault Tolerance # Classic Fault Tolerance
@@@ note @@include[includes.md](includes.md) { #actor-api }
For the new API see @ref:[fault tolerance](typed/fault-tolerance.md).
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).
@@@
## Dependency ## Dependency

10
akka-docs/src/main/paradox/fsm.md
View file

@ -1,16 +1,8 @@
# Classic FSM # Classic FSM
@@@ note @@include[includes.md](includes.md) { #actor-api }
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[fsm](typed/fsm.md). For the new API see @ref[fsm](typed/fsm.md).
@@@
## Dependency ## Dependency
To use Finite State Machine actors, you must add the following dependency in your project: 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
View 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 --->

11
akka-docs/src/main/paradox/index-actors.md
View file

@ -1,15 +1,6 @@
# Classic Actors # Classic Actors
@@@ note @@include[includes.md](includes.md) { #actor-api }
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).
@@@
## Dependency ## Dependency

9
akka-docs/src/main/paradox/index-classic.md
View file

@ -1,13 +1,6 @@
# Akka Classic # Akka Classic
@@@ note @@include[includes.md](includes.md) { #actor-api }
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.
@@@
@@toc { depth=2 } @@toc { depth=2 }

10
akka-docs/src/main/paradox/index-cluster.md
View file

@ -1,16 +1,8 @@
# Classic Clustering # Classic Clustering
@@@ note @@include[includes.md](includes.md) { #actor-api }
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](typed/index-cluster.md). For the new API see @ref[Cluster](typed/index-cluster.md).
@@@
@@toc { depth=2 } @@toc { depth=2 }
@@@ index @@@ index

10
akka-docs/src/main/paradox/index-network.md
View file

@ -1,16 +1,8 @@
# Classic Networking # Classic Networking
@@@ note @@include[includes.md](includes.md) { #actor-api }
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.
FIXME https://github.com/akka/akka/issues/27263 FIXME https://github.com/akka/akka/issues/27263
@@@
@@toc { depth=2 } @@toc { depth=2 }
@@@ index @@@ index

12
akka-docs/src/main/paradox/mailboxes.md
View file

@ -1,15 +1,7 @@
# Classic Mailboxes # Classic Mailboxes
@@@ note @@include[includes.md](includes.md) { #actor-api }
For the new API see @ref:[mailboxes](typed/mailboxes.md).
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).
@@@
## Dependency ## Dependency

9
akka-docs/src/main/paradox/persistence-fsm.md
View file

@ -1,13 +1,6 @@
# Classic Persistent FSM # Classic Persistent FSM
@@@ note @@include[includes.md](includes.md) { #actor-api }
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.
@@@
## Dependency ## Dependency

10
akka-docs/src/main/paradox/persistence.md
View file

@ -1,16 +1,8 @@
# Classic Persistence # Classic Persistence
@@@ note @@include[includes.md](includes.md) { #actor-api }
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[persistence](typed/persistence.md). For the new API see @ref[persistence](typed/persistence.md).
@@@
## Dependency ## Dependency
To use Akka Persistence, you must add the following dependency in your project: To use Akka Persistence, you must add the following dependency in your project:

10
akka-docs/src/main/paradox/routing.md
View file

@ -1,16 +1,8 @@
# Classic Routing # Classic Routing
@@@ note @@include[includes.md](includes.md) { #actor-api }
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[routers](typed/routers.md). For the new API see @ref[routers](typed/routers.md).
@@@
## Dependency ## Dependency
To use Routing, you must add the following dependency in your project: To use Routing, you must add the following dependency in your project:

12
akka-docs/src/main/paradox/scheduler.md
View file

@ -1,15 +1,7 @@
# Classic Scheduler # Classic Scheduler
@@@ note @@include[includes.md](includes.md) { #actor-api }
For the new API see @ref:[typed scheduling](typed/interaction-patterns.md#typed-scheduling).
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).
@@@
## Dependency ## Dependency

10
akka-docs/src/main/paradox/testing.md
View file

@ -1,16 +1,8 @@
# Testing Classic Actors # Testing Classic Actors
@@@ note @@include[includes.md](includes.md) { #actor-api }
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[testing](typed/testing.md). For the new API see @ref[testing](typed/testing.md).
@@@
## Dependency ## Dependency
To use Akka Testkit, you must add the following dependency in your project: To use Akka Testkit, you must add the following dependency in your project:

6
build.sbt
View file

@ -239,7 +239,11 @@ lazy val docs = akkaModule("akka-docs")
// Page that recommends Alpakka: // Page that recommends Alpakka:
"camel.html", "camel.html",
// TODO seems like an orphan? // 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, resolvers += Resolver.jcenterRepo,
apidocRootPackage := "akka", apidocRootPackage := "akka",