summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2017-09-12 18:42:32 +0200
committerAchilleas Pipinellis <axilleas@axilleas.me>2017-09-12 18:42:32 +0200
commit57d0d603432f8c3f8cce1973e2a45865631fcd02 (patch)
treead67db1bc552a8317dfe974f02d1c31b0b517632
parent5d952f756bcf0355fc5d86d819dfc6913c0ae351 (diff)
downloadgitlab-ce-docs/alerts-styleguide.tar.gz
Add alerts to doc styleguidedocs/alerts-styleguide
-rw-r--r--doc/development/doc_styleguide.md30
1 files changed, 20 insertions, 10 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index 798f40eef3d..9df5f30f737 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -222,21 +222,31 @@ Inside the document:
- If a heading is placed right after an image, always add three dashes (`---`)
between the image and the heading
-## Notes
+## Alerts
-- Notes should be quoted with the word `Note:` being bold. Use this form:
+There are four types of alerts: note, tip, caution, danger.
+They should be capitalized and followed by a colon. For example, the following:
- ```
- >**Note:**
- This is something to note.
- ```
+```
+NOTE: This is something to note.
+
+TIP: This is a tip.
+
+CAUTION: This is something to be careful about.
+
+DANGER: This is something that causes a destructive action.
+```
+
+would render like:
+
+
+NOTE: This is something to note.
- which renders to:
+TIP: This is a tip.
- >**Note:**
- This is something to note.
+CAUTION: This is something to be careful about.
- If the note spans across multiple lines it's OK to split the line.
+DANGER: This is something that causes a destructive action.
## New features