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
This commit is contained in:
Johan Andrén 2019-11-05 20:06:32 +01:00 committed by Patrik Nordwall
parent c74e9720f3
commit 8d19962dc8
38 changed files with 74 additions and 120 deletions

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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).

View file

@ -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

View file

@ -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.

View file

@ -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:

View file

@ -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?

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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:

View file

@ -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

View file

@ -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

View file

@ -1,8 +1,6 @@
# Actor discovery
@@@ note
For the Akka Classic documentation of this feature see @ref:[Classic Actors](../actors.md#actorselection).
@@@
## Dependency

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -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).

View file

@ -1,8 +1,6 @@
# Interaction Patterns
@@@ note
For the Akka Classic documentation of this feature see @ref:[Classic Actors](../actors.md).
@@@
## Dependency

View file

@ -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

View file

@ -1,8 +1,6 @@
# Mailboxes
@@@ note
For the Akka Classic documentation of this feature see @ref:[Classic Mailboxes](../mailboxes.md).
@@@
## Dependency

View file

@ -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

View file

@ -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

View file

@ -1,8 +1,6 @@
# Routers
@@@ note
For the Akka Classic documentation of this feature see @ref:[Classic Routing](../routing.md).
@@@
## Dependency

View file

@ -1,8 +1,6 @@
# Stash
@@@ note
For the Akka Classic documentation of this feature see @ref:[Classic Actors](../actors.md#stash).
@@@
## Dependency

View file

@ -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.

View file

@ -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.

View file

@ -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

View file

@ -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")