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
1af71196
Commit
1af71196
authored
Jul 01, 2019
by
Mike Lewis
Committed by
Evan Read
Jul 01, 2019
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update styleguide.md to add Notes usage guidelines
parent
bc71d0b4
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
18 additions
and
1 deletion
+18
-1
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+18
-1
No files found.
doc/development/documentation/styleguide.md
View file @
1af71196
...
@@ -577,7 +577,7 @@ nicely on different mobile devices.
...
@@ -577,7 +577,7 @@ nicely on different mobile devices.
## Alert boxes
## Alert boxes
Whenever you
want to call the attention to a particular sentence
,
Whenever you
need to call special attention to particular sentences
,
use the following markup for highlighting.
use the following markup for highlighting.
_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,
...
@@ -585,6 +585,23 @@ lists, headers, etc will not render correctly. For multiple lines, use blockquot
...
@@ -585,6 +585,23 @@ lists, headers, etc will not render correctly. For multiple lines, use blockquot
### Note
### Note
Notes catch the eye of most readers, and therefore should be used very sparingly.
In most cases, content considered for a note should be included:
- As just another sentence in the previous paragraph or the most-relevant paragraph.
- As its own standalone paragraph.
- As content under a new subheading that introduces the topic, making it more visible/findable.
#### When to use
Use a note when there is a reason that most or all readers who browse the
section should see the content. That is, if missed, it’s likely to cause
major trouble for a minority of users or significant trouble for a majority
of users.
Weigh the costs of distracting users to whom the content is not relevant against
the cost of users missing the content if it were not expressed as a note.
```
md
```
md
NOTE:
**Note:**
NOTE:
**Note:**
This is something to note.
This is something to note.
...
...
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