...

A special file containing asciidoctor configuration settings and variable definitions. Currently only one config is used, but others could be added for special use cases.

ganization

An Omnibus of the documentation is compiled from system-wide documentation and all application data. Builds are configured to build and deploy html and pdf versions of all documentation.

All content is actually contained in files .adoc files that follow a naming convention ending in "contents" (`mancontents.adoc`, for example). To keep these partial files from rendering, they are placed in directories named with a leading underscore (`_contents`). These files are "included" by asciidoctor into the proper section of the documentation. 

Section Titles and Headings

To keep the outline of the documentation consistent, headers should be used according to the following guidelines.

= This creates an <h1> heading. Asciidoctor only allows one instance per document, for the title
== <h2> reserved for Application headings
=== <h3> this level shows up on the Table of Contents sidebar, so should be used sparingly, for major sections
==== <h4> This heading will (and those above it) will create a section anchor that can be directly linked, but will not display on the table of contents. 
===== <h5> 
====== <h6>

Headers should also not be used without a title as multiple equal signs can also start a callout block that can cause rendering to break.

Content Templates

The documentation is segmented by intended audience. 

Core Concepts

This section consists of high-level, non-technical overviews of the main features of the project.

Managing

The managing sections are intended for system administrators installing and/or maintaining an installation. This section should primarily focus on how-to tasks and explaining the various configuration options.

Sections to include:

• Prerequisites (other applications that this app depends on)
• Installation instructions  (including whether app is installed by default)
• Configuration instructions (including calling out any configurations that must be changed from the default)

Integrating

The integrating sections are intended for integrators connecting programmatically to the project from another program or framework.

Developing

The developing section details internal implementation and starting points for extending components of the project.