opensuse: new section

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

diff --git a/contrib-guide.md b/contrib-guide.md
index 5ae90797f85a603b33272795c9ff54fd1354ac1f..5728a5ddaf0844254bfc2ea525896c469028643a 100644 (file)
--- a/contrib-guide.md
+++ b/contrib-guide.md
@@ -88,8 +88,11 @@ Tip/note block:
 </div>
 ```
 
-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
@@ -187,29 +190,17 @@ Results of commands, if needed, should be presented in a simple
 Use
 
 ```html
-<div class="img img-70">
+<figure class="img img-70">
     <img src="/images/docs26/image-name.png" alt="Short description">
-</div>
+</figure>
 ```
 
+Replace `docs26` with the appropriate version tag depending on the
+checked out branch.
+
 to display an image. Change `img-70` to `img-` followed by the
 width percentage you wish.
 
-The SVG format is preferred. In this case, use the `<object>` tag to
-render an interactive SVG, with an inner raster image fallback for
-basic browsers:
-
-```html
-<div class="img img-90">
-  <object data="/images/docs26/image-name.svg" type="image/svg+xml">
-    <img src="/images/docs26/image-name.png" alt="Short description">
-  </object>
-</div>
-```
-
-An interactive SVG object allows its text to be selected, amongst other
-features.
-
 
 Convention
 ----------
@@ -236,7 +227,9 @@ 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