This directory contains the source documentation that constitutes both the Apache Isis' documentation (meaning the website and the users' guide, the reference guide and contributors' guide) It is written using Asciidoc, specifically the Asciidoctor implementation.
The website is created by running build tools (documented below) which create the HTML version of the site and guides. You can therefore easily check the documentation before raising a pull request
So, if you want to contribute documentation - either just to fix a typo, or to write a how-to or longer article - then fork the repo, write or modify the the
.adoc source file, and raise a pull request.
For documents with inclusions, use '_' to separate out the logical hierarchy:
xxx-xxx/xxx-xxx.adoc _xxx-xxx_ppp-ppp.adoc _xxx-xxx_qqq-qqq.adoc _xxx-xxx_qqq-qqq_mmm-mmm.adoc _xxx-xxx_qqq-qqq_nnn-nnn.adoc
Any referenced images should be in subdirectories of the
xxx-xxx/images/. /ppp-ppp/. /qqq-qqq/. /mmm-mmm /nnn-nnn
And similarly any resources should be in the
xxx-xxx/resources/. ppp-ppp/. qqq-qqq/. /mmm-mmm/ /nnn-nnn/
Build and Review (using Maven)
To (re)build the documentation locally prior to release, use:
The site will be generated at
target/site/index.html, and then uses Python to start a webserver and a browser pointing at the site.