This will link to the Github edit screen where you can make changes, preview them and create a pull request.

Building the Guide

If you want to make significant changes, such as changing the structure of the table of contents etc. then we recommend you build the user guide. To do that simply checkout the sources from github:

Each YAML key points to a Asciidoc template. For example consider the following YAML:

The introduction key points to src/en/guide/introduction.adoc. The key defines the title that is dislayed in the TOC. Because whatsNew key is nested underneath the introduction key it points to src/en/guide/introduction/whatsNew.adoc, which is nested in a directory called .

To generate the documentation run the publishGuide task:

Once the guide is built simply open the file in a browser to review your changes.