Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
--------
The online documentation published at <http://lttng.org/docs/> is always
--------
The online documentation published at <http://lttng.org/docs/> is always
--------------------
`toc/docs.yml` is a YAML tree of all chapters, sections and subsections.
--------------------
`toc/docs.yml` is a YAML tree of all chapters, sections and subsections.
and it will potentially output a list of errors and warnings.
and it will potentially output a list of errors and warnings.
-----------------
The sources are made of a fusion of Markdown and HTML processed by
-----------------
The sources are made of a fusion of Markdown and HTML processed by
preserve the document's visual consistency.
preserve the document's visual consistency.
+#### Tip/note/warning/error blocks
Title should be `Tip:` for a tip and `Note:` for a note.
Title should be `Tip:` for a tip and `Note:` for a note.
Internal links should always use Markdown
(`[caption](#doc-section)`). External links, however, need a special
Internal links should always use Markdown
(`[caption](#doc-section)`). External links, however, need a special
analyzer from complaining (`tools/checkdocs.py`).
analyzer from complaining (`tools/checkdocs.py`).
Use `<abbr>` for describing abbreviations. This should only be used
for the first use of the abbreviation:
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.
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
You must use `<em>` to emphasize a placeholder within a `<code>` tag
because Markdown backticks (<code>`</code>) always render their
A terminal box, where command lines are shown, is a simple `<pre>`
with the `term` class:
A terminal box, where command lines are shown, is a simple `<pre>`
with the `term` class:
----------
A few rules to comply with in order to keep the text as
----------
A few rules to comply with in order to keep the text as
_we_ have an ongoing example.
_we_ have an ongoing example.
----------
If you make a change to a single contents file, prefix your Git commit
----------
If you make a change to a single contents file, prefix your Git commit