Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
25d9e62b
Commit
25d9e62b
authored
Aug 05, 2021
by
Craig Norris
Committed by
Suzanne Selhorn
Aug 05, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add FLAG alert type to Style Guide
parent
565a4b68
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
2 deletions
+12
-2
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+12
-2
No files found.
doc/development/documentation/styleguide/index.md
View file @
25d9e62b
...
@@ -1337,8 +1337,13 @@ example:
...
@@ -1337,8 +1337,13 @@ example:
Use alert boxes to call attention to information.
Use alert boxes to call attention to information.
Alert boxes are generated when the words
`NOTE:`
or
`WARNING:`
are followed by a
Alert boxes are generated when one of these words is followed by a line break:
line break. For example:
-
`FLAG:`
-
`NOTE:`
-
`WARNING:`
For example:
```
markdown
```
markdown
NOTE:
NOTE:
...
@@ -1351,6 +1356,11 @@ To display an alert box for multiple paragraphs, lists, or headers, use
...
@@ -1351,6 +1356,11 @@ To display an alert box for multiple paragraphs, lists, or headers, use
Alert boxes render only on the GitLab documentation site (
<https://docs.gitlab.com>
).
Alert boxes render only on the GitLab documentation site (
<https://docs.gitlab.com>
).
In the GitLab product help, alert boxes appear as plain text.
In the GitLab product help, alert boxes appear as plain text.
### Flag
Use this alert type to describe a feature's availability. For information about how to format
`FLAG`
alerts, see
[
Document features deployed behind feature flags
](
../feature_flags.md
)
.
### Note
### Note
Use notes sparingly. Too many notes can make topics difficult to scan.
Use notes sparingly. Too many notes can make topics difficult to scan.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment