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
4c316046
Commit
4c316046
authored
Sep 23, 2020
by
Craig Norris
Committed by
Suzanne Selhorn
Sep 23, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs: Update Style Guide with Notes guidance
parent
8785cfb8
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
11 additions
and
13 deletions
+11
-13
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+11
-13
No files found.
doc/development/documentation/styleguide.md
View file @
4c316046
...
...
@@ -1458,23 +1458,21 @@ guidelines, but for consistency you should try to use these values:
### 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:
Notes
indicate information that is of special use to the reader, and are most
effective when used _sparingly_.
-
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 or findable.
The goal for notes is to not use them at all. If, however, a note is truly
required, do not use more than _two_ notes per documentation page.
#### When to use
Instead of a note, try one of these alternatives:
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.
-
Re-write the sentence as part of the most-relevant
paragraph.
-
Put the information into its own standalone paragraph.
-
Put the content under a new subheading that introduces the topic. This makes it more
visible.
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.
If you must use a note, use the following formatting:
```
markdown
NOTE:
**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