Akka Microservices

Learn more at akka.io.

Reference Documentation

The reference documentation is available at doc.akka.io.

Example code

The example projects used in the documentation are located at

• Akka Microservices (Event sourcing and CQRS) in Scala

Antora-based Akka Documentation

This folder contains the sources for parts of the Akka web site.

This folder is structured as follows:

• The root directory contains the makefile for the documentation generation process.
• The structured documentation is located under docs-source/.

Contributions to the documentation are welcome and encouraged. If you are unfamiliar with the project or with asciidoc, please read the contribution guidelines below.

Contributing to the Akka Documentation

Detailed information about working with the documentation is provided in the docs-source folder.

Building the Documentation

This part of the Akka documentation is built using Antora, from asciidoc sources. The building process is managed by make using the makefile script.

To build the documentation, use make with the following commands:

• make html-author-mode

  Generates the documentation, in 'author' mode, to display review comments and TODOs. The result is available at target/staging/index.html.

• make all (default)

  Generates the complete documentation bundle.

• make html

  Generates the html documentation and homepage.

• make check-links

  Checks that the external links point to a reachable URL.

• make list-todos

  List all the TODOs, review comments, unresolve references, etc. from the documentation.

License

Akka is Open Source and available under the Apache 2 License.