Welcome to the Kroxylicious documentation!
This folder contains the source files for managing the Kroxylicious documentation. The documentation is written in AsciiDoc and provides content to help you understand and set up Kroxylicious. US (global) English is used throughout.
- Kroxylicious guide
- Documentation folder structure
- Generating the guide
- Contributing to the documentation
The Kroxylicious documentation is organized into a single Kroxylicious guide. The content for the guide is encapsulated in a main index file:
The index file is used to build the documentation.
Documentation folders contain the content that's incorporated into the main source files.
An assembly is like a sub-section or chapter in a book.
A module contain a procedure (proc-), concepts (con-), or reference (ref-) content.
Documentation folders
| Folder | Description |
|---|---|
assemblies/ |
Assemblies (chapters) group related content |
modules/ |
Modules provide content for assemblies |
_assets/ |
Content common to all doc files |
shared/attributes.adoc |
Global book attributes |
To generate the guide in HTML, run the following Maven command:
mvn org.asciidoctor:asciidoctor-maven-plugin:process-asciidoc@convert-to-htmlThe HTML is output to target/html/index.html.
If there's something that you want to add or change in the documentation, do the following:
- Fork the repository
- Set up a local Git repository by cloning the forked repository
- Create a branch for your changes
- Add the changes through a pull request
The pull request will be reviewed and the changes merged when the review is complete. The guide is then rebuilt and the updated content is published on the Kroxylicious website. Published documentation for the current main branch as well as all releases can be found on our website.