instrumenting-linux-kernel-tracing: fix wrong module name

[lttng-docs.git] / contrib-guide.md

diff --git a/contrib-guide.md b/contrib-guide.md
index 0293c4d83c899824e5c8255ddbb3866f7d337e59..0e69d6689d0c1c597e8e22f237783ff958ebcb6f 100644 (file)
--- 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 <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
@@ -178,7 +187,7 @@ 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>
 ```
 
@@ -191,8 +200,8 @@ basic browsers:
 
 ```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>
 ```
@@ -227,3 +236,12 @@ consistent as possible:
   * 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.
+
+
+committing
+----------
+
+If you make a change to a single contents file, prefix your Git commit
+message's first line with the file ID followed by `: `, e.g:
+
+    archlinux: minor fix