X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=contrib-guide.md;h=5728a5ddaf0844254bfc2ea525896c469028643a;hb=68c787104211966ed10bc1474e8b40db52a78535;hp=38366843d0fa5e60cdc0cab452a85bf9f2d4ff79;hpb=1c13c8bddceb4b05935c347daafc755e270f45e4;p=lttng-docs.git diff --git a/contrib-guide.md b/contrib-guide.md index 3836684..5728a5d 100644 --- a/contrib-guide.md +++ b/contrib-guide.md @@ -190,29 +190,17 @@ Results of commands, if needed, should be presented in a simple Use ```html -
+
Short description -
+ ``` +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 `` tag to -render an interactive SVG, with an inner raster image fallback for -basic browsers: - -```html -
- - Short description - -
-``` - -An interactive SVG object allows its text to be selected, amongst other -features. - Convention ---------- @@ -239,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