X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=contrib-guide.md;h=4f45918a5a9463dc1b815d3aed971978470cfa27;hb=85ccb28b9a18a29b9515e2d445185f8d0241c5f2;hp=456c120802282fd7189eb7d12d49bb013ad0144f;hpb=7d603874e0cd6d4a2195e7e2ce561a00351ad428;p=lttng-docs.git
diff --git a/contrib-guide.md b/contrib-guide.md
index 456c120..4f45918 100644
--- a/contrib-guide.md
+++ b/contrib-guide.md
@@ -6,8 +6,17 @@ Documentation's source. Make sure you read it thoroughly before
contributing a change.
-structure
----------
+Branches
+--------
+
+The online documentation published at 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
@@ -45,7 +54,7 @@ Run it from the repository's root:
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
@@ -63,7 +72,7 @@ document. If you need to contribute, please use them when needed to
preserve the document's visual consistency.
-#### tip/note block
+#### Tip/note/warning/error blocks
Tip/note block:
@@ -79,10 +88,14 @@ Tip/note block:
```
-Title should be `Tip:` for a tip and `Note:` for a note.
+Replace the `tip` class with `warn` for a warning block, and with `err`
+for an error message block (when JavaScript is needed but is disabled, etc.).
+
+Title should be `Tip:` for a tip, `Note:` for a note, `Warning:` for a
+warning, and `Error:` for an error.
-#### external links
+#### External links
Internal links should always use Markdown
(`[caption](#doc-section)`). External links, however, need a special
@@ -99,7 +112,7 @@ In these cases, add the `int` CSS class as a hint to prevent the static
analyzer from complaining (`tools/checkdocs.py`).
-#### abbreviations
+#### Abbreviations
Use `` for describing abbreviations. This should only be used
for the first use of the abbreviation:
@@ -110,7 +123,7 @@ project is an open source system software package [...]
```
-#### non-breaking spaces
+#### Non-breaking spaces
Sometimes, a non-breaking space HTML entity (` `) needs to be
explicitly written.
@@ -126,7 +139,7 @@ A check is performed every 3000 ms.
```
-#### placeholders in inline code
+#### Placeholders in inline code
You must use `` to emphasize a placeholder within a `` tag
because Markdown backticks (`) always render their
@@ -138,7 +151,7 @@ Name your file something_sys.c, where
```
-#### terminal boxes
+#### Terminal boxes
A terminal box, where command lines are shown, is a simple `
`
with the `term` class:
@@ -172,13 +185,13 @@ Results of commands, if needed, should be presented in a simple
-#### images
+#### Images
Use
```html
-
+
```
@@ -191,8 +204,8 @@ basic browsers:
```html
-
```
@@ -201,7 +214,7 @@ An interactive SVG object allows its text to be selected, amongst other
features.
-convention
+Convention
----------
A few rules to comply with in order to keep the text as
@@ -226,10 +239,12 @@ consistent as possible:
(good: `include/trace/events`, bad: `include/trace/events/`).
* Keep the text as impersonal as possible (minimize the use of
_I_, _we_, _us_, etc.), except for user guides/tutorials where
- _we_ have an ongoing example.
+ _we_ have an ongoing example with _you_.
+ * Minimize the use of the future tense (_will_).
+ * Do not use Latin abbreviations (_e.g._, _i.e._, _etc._).
-committing
+Committing
----------
If you make a change to a single contents file, prefix your Git commit