contributing a change.
-structure
----------
+Branches
+--------
+
+The online documentation published at <http://lttng.org/docs/> is always
+compiled from the sources of this repository's latest stable branch.
+The `master` branch contains the current documentation of the upcoming
+LTTng release.
+
+
+Structure of sources
+--------------------
`toc/docs.yml` is a YAML tree of all chapters, sections and subsections.
It indicates which unique ID is linked to which position in the
and it will potentially output a list of errors and warnings.
-format of sources
+Format of sources
-----------------
The sources are made of a fusion of Markdown and HTML processed by
preserve the document's visual consistency.
-#### tip/note block
+#### Tip/note/warning/error blocks
Tip/note block:
Title should be `Tip:` for a tip and `Note:` for a note.
-#### external links
+
+#### External links
Internal links should always use Markdown
(`[caption](#doc-section)`). External links, however, need a special
analyzer from complaining (`tools/checkdocs.py`).
-#### abbreviations
+#### Abbreviations
Use `<abbr>` for describing abbreviations. This should only be used
for the first use of the abbreviation:
```
-#### non-breaking spaces
+#### Non-breaking spaces
Sometimes, a non-breaking space HTML entity (` `) needs to be
explicitly written.
```
-#### placeholders in inline code
+#### Placeholders in inline code
You must use `<em>` to emphasize a placeholder within a `<code>` tag
because Markdown backticks (<code>`</code>) always render their
```
-#### terminal boxes
+#### Terminal boxes
A terminal box, where command lines are shown, is a simple `<pre>`
with the `term` class:
</pre>
-#### images
+#### Images
Use
```html
<div class="img img-70">
- <img src="/images/docs/image-name.png" alt="Short description">
+ <img src="/images/docs26/image-name.png" alt="Short description">
</div>
```
```html
<div class="img img-90">
- <object data="/images/docs/image-name.svg" type="image/svg+xml">
- <img src="/images/docs/image-name.png" alt="Short description">
+ <object data="/images/docs26/image-name.svg" type="image/svg+xml">
+ <img src="/images/docs26/image-name.png" alt="Short description">
</object>
</div>
```
features.
-convention
+Convention
----------
A few rules to comply with in order to keep the text as
_we_ have an ongoing example.
-committing
+Committing
----------
If you make a change to a single contents file, prefix your Git commit