This file is not fleshed out, it's just a collection of tips. A lot of inspiration has been gained from the Hibernate-OGM project documentation, as well as the AsciiDoctor website sources, which also uses AsciiDoc for documentation as well as Awestruct to build and publish the website.
Read the Contributing To Infinispan Guide's section on Writing Documentation for more details.
You will want to install the entire AsciiDoctor toolchain on your computer.
A pom.xml file is included here, but this is experimental and probably will
not work.
TIP: Don't bother with it.
There are scripts in the Infinispan Website repository which are capable of grabbing docs from here and building/integrating the docs as a part of the Infinispan.org website.
NOTE: This is the preferred method of rendering the documentation.
Naturally, while editing the docs, you don't want to have to build the entire website to see your changes. A good way to do this is to set up live previews as described here.
A Guardfile is included here in this repository which should be used instead of the Guardfile as specified in the link above.
This will ensure proper application of stylesheets, etc.
NOTE: Aggregate files (i.e., using AsciiDoc's include directive) does not work with live previews.
However, these will be rendered correctly when the site is properly built.