Editor's Guide

(just started, work in progress)

Terms and spelling

• Nouns that have a specific meaning in the UBOS context are spelled in CamelCase. Specifically, this is the way the following items should be written:
  • :term:`App`
  • :term:`Accessory`
  • :term:`Site`
  • :term:`AppConfiguration`
  • :term:`AppConfigurationItem`

Conventions

All code is shown like this: print().

All text that could appear verbatim in a Site JSON file or a UBOS Manifest is shown like this: mysql.

When performing a command as a non-root user, the shell prompt is %:

% whoami
shepherd

When performing a command as root, the shell prompt is #:

# whoami
shepherd

Syntax reminders

Sphinx

Inline code

Inline code goes in single backquotes like this: `printf()`.

Multi-line code

Multi-line code goes into a pre section (not tilde):

<pre>
printf();
printf();
</pre>

Jekyll

Inline code goes in double backquotes like this: ``printf()``.

Inline code

Single back quotes are for italics (which we don't use).

Multi-line code

Multi-line code goes into this special construct, here for json:

.. code-block:: json
   {
       "retention"       : "backup",
       "retentionbucket" : "uploads"
   }

Links

Text in square brackets, followed by the URL in parentheses:

[Getting started](https://ubos.net/quickstart/)