Hi Benoit, > In an evening effort, I started writing a documentation skeleton for the > Distributed James server with the new Antora Documentation.
Awesome, thanks! > In order to juge the results I came up with (and do some corrections as > I am new to this technology) I would like to generate the result of my work. I just created an issue for this: https://issues.apache.org/jira/browse/JAMES-3258 > Can someone provide me the commands needed to generate the documentation > website? (I successfully installed Antora and http-server) In the meantime, here I will explain how you can generate it locally. Since you have already installed Antora, this should be all you need to do: Create a local file with contents like this (replacing with a hard-coded value your correct local [path-to-local-repos]): [local-antora-playbook.yml] ``` site: title: Apache James url: https://james.apache.org/ start_page: main::index.adoc content: sources: - url: [path-to-local-repos]/james-project branches: HEAD start_path: docs - url: [path-to-local-repos]/james-jsieve branches: HEAD start_path: docs ui: bundle: url: [path-to-ui-bundle]/ui-bundle.zip runtime: fetch: true ``` To visualize the results correctly, I will need to send you the ui-bundle.zip. I will attach it to the issue. (We need to create our own ui-bundle.zip, which creates the page outline, includes the James branding etc.) To run the build, just do: ``` antora local-antora-playbook.yml ``` Then open your browser and go to file:///[path-to-your-playbook]/build/site/main/3.5/index.html Let me know if you have any issues and I will try to help you out. I am by no means an expert in Antora, but I do have it working just fine locally. Cheers, =David
signature.asc
Description: Message signed with OpenPGP