Style guide

Headings

All headings should start off as level 2. The title set in the front matter will be displayed at the top of the rendered html page and uses the level 1 heading.

Technical jargon

italicize jargon on first use:

catalog roots

client catalog

configuration catalog

_catalog roots_

_client catalog_

_configuration catalog_

inline text html, xml elements, properties, code variables, snippets, file paths, surround in back ticks, like this:

<catalog>

`<catalog>`

Keeping git diffs clean

One line of text per line in file. A blank line is needed for new paragraph, so no formatting issues in doing this. This keeps git diff clean

One line of text per line in file.
A blank line is needed for new paragraph, so no formatting issues in doing this.
This keeps git diff clean