Commit 9dd08f63 authored by Craig Norris's avatar Craig Norris

Merge branch 'mjang-alternative-wording-alert-boxes-1' into 'master'

Add info that we allow alternative words in alert boxes

See merge request gitlab-org/gitlab!41377
parents cd6cf73b a66532bc
...@@ -1410,8 +1410,8 @@ example: ...@@ -1410,8 +1410,8 @@ example:
## Alert boxes ## Alert boxes
Whenever you need to call special attention to particular sentences, use the When you need to call special attention to particular sentences, use the
following markup for highlighting. following markup to create highlighted alert boxes.
Note that the alert boxes only work for one paragraph only. Multiple paragraphs, Note that the alert boxes only work for one paragraph only. Multiple paragraphs,
lists, headers and so on, will not render correctly. For multiple lines, use lists, headers and so on, will not render correctly. For multiple lines, use
...@@ -1421,6 +1421,16 @@ Alert boxes render only on the GitLab documentation site (<https://docs.gitlab.c ...@@ -1421,6 +1421,16 @@ Alert boxes render only on the GitLab documentation site (<https://docs.gitlab.c
Within GitLab itself, they will appear as plain Markdown text (like the examples Within GitLab itself, they will appear as plain Markdown text (like the examples
above the rendered versions, below). above the rendered versions, below).
These alert boxes are used in the GitLab documentation. These aren't strict
guidelines, but for consistency you should try to use these values:
| Color | Markup | Default keyword | Alternative keywords |
|--------|------------|-----------------|----------------------------------------------------------------------|
| Blue | `NOTE:` | `**Note:**` | |
| Yellow | `CAUTION:` | `**Caution:**` | `**Warning:**`, `**Important:**` |
| Red | `DANGER:` | `**Danger:**` | `**Warning:**`, `**Important:**`, `**Deprecated:**`, `**Required:**` |
| Green | `TIP:` | `**Tip:**` | |
### Note ### Note
Notes catch the eye of most readers, and therefore should be used very sparingly. Notes catch the eye of most readers, and therefore should be used very sparingly.
...@@ -1637,7 +1647,7 @@ heading level. ...@@ -1637,7 +1647,7 @@ heading level.
warning such as: warning such as:
```markdown ```markdown
CAUTION: **Warning:** DANGER: **Deprecated:**
This feature was [deprecated](link-to-issue) in GitLab 12.3 This feature was [deprecated](link-to-issue) in GitLab 12.3
and replaced by [Feature name](link-to-feature-documentation). and replaced by [Feature name](link-to-feature-documentation).
``` ```
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment