Writing Guide


#1

This page contains detailed information on how to become a successful MAAS documentation writer. Welcome to the club.

Contribution overview

Once you have permission to edit the doc, you can modify any article by choosing the link at the bottom, entitled, “Help improve this document in the forum.” Recognize that what you change will be posted instantly. Check your work carefully before saving your edits!

Some questions to ask yourself as you are contributing:

  • Does your reply improve the conversation in some way?

  • Is your contribution kind to fellow community members?

  • Is your constructive criticism focused on ideas, and not people?

  • Are you certain of the technical accuracy of your contribution?

If you can answer these questions in the affirmative, your edits should be welcome.

Style and language

Please follow these guidelines for style and language:

  • Use a spell checker.
  • Resist being overly formal.
  • Verify hyperlinks and examples.
  • Target audience: intermediate system administrator, not a developer.
  • Use British English (en-GB). See language details, including a comparison with American English (en-US).
  • Never break a hyperlink with a carriage return.

Note that the document markup is not particularly complicated. For the most part, if you rely on the formatting bar just above the editor window – or use standard HTML – you shouldn’t have much difficulty.

Headers

Headers are simple to create, using standard HTML:

<h2 id="optional-unique-id>Heading Level 2</h2>
<h3 id="optional-unique-id>Heading Level 3</h3>
... and so on...

Bold and Italic Text

Bold and italic text can be indicated in two different ways. You can use standard HMTL markup:

<strong>Bold Text</strong>
<em>Italic Text</em>

You can also use the local editor markup:

**strong**
_italic_ (note that's just a single underbar)

Code blocks

A code block (or preformatted text) is inserted by indenting four spaces:

maas command do something
maas command do something else
```

You can use this style anytime you want to present:

  • a command line sequence,
  • a preformatted block of text,
  • a block of text in which you need to escape markup sequences (as above),
  • a code listing where indentation and monospace font are important.

Inline code

Use a <code> tag to mark inline filenames and other literals as code examples. Alternatively, you can also use the backtick, like this:

...can also use the `backtick`, like this...

Admonishments

An admonishment distinguishes information from the rest of the text. The syntax begins with the markup tag [note] and ends with the corresponding closure [/note]:

[note type="admonishment-type" status="Admonishment title"]
Admonishment text.
[/note]

Where:

  • admonishment-type can be ‘Note’, ‘Warning’, ‘Positive’, or ‘Negative’.
  • Admonishment title is an optional title, formatted with whatever markups you desire.
  • Admonishment text is the text you wish to convey.

Admonishment examples

Note Admonishment

A ‘Note’ type admonishment is marked up like this:

[note status="Note"]
If KVM-backed nodes are used, ensure that the 'maas' user on the rack
controller can connect to the KVM host using a passphraseless private SSH
key.
[/note]

And it will appear as:

Note: If KVM-backed nodes are used, ensure that the ‘maas’ user on the rack controller can connect to the KVM host using a passphraseless private SSH key.

Warning Admonishment

Mark up a standard ‘Warning’ type admonishment this way:

[note type="caution" status="Warning"]
Data will be lost unless you do the right thing.
[/note]

And it will appear like this:

Warning: Data will be lost unless you do the right thing.

Positive Admonishment

A ‘Positive’ type admonishment should be entered as follows:

[note type="positive" status="High score"]
A positive note that should include a title.
[/note]

It will show up in the document like this:

High score: A positive note that should include a title.

Negative Admonishment

Finally, a ‘Negative’ type admonishment, with its title, could be marked up like this:

[note type="negative" status="Game over"]
A negative note that should include a title.
[/note]

And will look this way to the reader:

Game over: A negative note that should include a title.

Comments

Occasionally it may be appropriate to include a comment to explain or organize some text. This ends up as an HTML comment – which can be read online, even if only in the browser inspection window – so take it seriously:

<!--
The below text may be removed soon.
-->

Links to internal files or external URLs use the following format:

[visible text](URL)

The visible text is what will appear on the web page. The URL is used to refer to the destination, which is a fully-qualified URL. For example:

Refer to [Google](https://www.google.com).

which would show up as “Refer to Google.”

Images

An image should not be overly cropped - allow for context. When ready, place the image file in the uploads directory.

In terms of linking, they are managed very similarly to hyperlinks. However, they are placed on their own line; are preceded by an exclamation point; and both the label and destination have a specific naming convention:

![web UI showing node view](/uploads/default/original/1X/1f2e6cf2879e391e7ae1ad537cc9ce1baa119f86.png)

This image would appear in this way:

Capitalization

Do not use a “Caps Everywhere” style. It is only used in level one headers and the title metadata. References (visible text) to these page titles (including the navigation) should just capitalize the first letter. Obviously, this does not pertain to words that should always be capitalized according to basic grammar rules (e.g. acronyms, proper nouns).


MAAS Documentation
Documentation index