Building the next gen documentation

The old maven site is quite painful to maintain and doesn’t allow for versionning of the content per releases which motivated the migration effort.

Most of the maven site content has been migrated to asciidoc files assembled by antora. You can preview the content at https://james.staged.apache.org, this documentation is published automatically by the james CI.

This new documentation root is located in the docs directory and includes these build instructions.

Executing within source code

(Clone https://github.com/apache/james-project locally, go into docs folder)

1. Install Antora

2. Build the Antora content locally

    $ antora antora-playbook-local.yml

3. Open build/site/index.html in your browser.

Building with Dockerfile

To build the document from apache-james repository, you can use the Dockerfile provided in this folder.

Build the Docker image:

docker build --build-arg JAMES_CHECKOUT=master -f Dockerfile -t james-site-antora .

Then run the Docker image:

docker run -p 80:80 james-site-antora

Go to http://localhost in your browser.

Build with the nix enviroment

Enter the james experimental development shell with nix develop

1. Build the Antora content locally

    $ antora antora-playbook-local.yml

2. Open build/site/index.html in your browser.