From: Philippe Proulx Date: Fri, 4 Sep 2015 02:03:51 +0000 (-0400) Subject: contrib-guide.md: add info about warning/error blocks X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=1c13c8bddceb4b05935c347daafc755e270f45e4;p=lttng-docs.git contrib-guide.md: add info about warning/error blocks Signed-off-by: Philippe Proulx --- diff --git a/contrib-guide.md b/contrib-guide.md index 5ae9079..3836684 100644 --- a/contrib-guide.md +++ b/contrib-guide.md @@ -88,8 +88,11 @@ 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