This is an automated email from the ASF dual-hosted git repository. chibenwa pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
commit c81bc7ec0900d6201c8cb388b6bc069b0c1c5eee Author: Benoit TELLIER <[email protected]> AuthorDate: Mon Aug 24 00:18:09 2026 +0700 [DOC] README located within the Antora doc --- docs/README.adoc | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/docs/README.adoc b/docs/README.adoc new file mode 100644 index 0000000000..32985ff44f --- /dev/null +++ b/docs/README.adoc @@ -0,0 +1,59 @@ +== 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 +https://issues.apache.org/jira/browse/JAMES-3187[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) + +. https://docs.antora.org/antora/latest/install-and-run-quickstart/[Install Antora] + +. Build the Antora content locally ++ +[,shell] +---- + $ antora antora-playbook-local.yml +---- ++ +. 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 link:https://james.apache.org/contribute.html[james experimental +development shell] with `nix develop` + +. Build the Antora content locally ++ +[,shell] +---- + $ antora antora-playbook-local.yml +---- ++ +. Open `build/site/index.html` in your browser. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
