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
c8efe0e8
Commit
c8efe0e8
authored
Sep 29, 2020
by
Susan Tacker
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update Note description in styleguide.md
parent
5b59ffcf
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
7 deletions
+6
-7
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+6
-7
No files found.
doc/development/documentation/styleguide.md
View file @
c8efe0e8
...
@@ -901,8 +901,8 @@ search engine optimization (SEO), use the imperative, where possible.
...
@@ -901,8 +901,8 @@ search engine optimization (SEO), use the imperative, where possible.
For guidelines on capitalizing headings, see the section on
[
capitalization
](
#capitalization
)
.
For guidelines on capitalizing headings, see the section on
[
capitalization
](
#capitalization
)
.
NOTE:
**Note:**
NOTE:
**Note:**
If you change an existing title, be careful.
Any such changes may
affect not
If you change an existing title, be careful.
These changes might
affect not
only
[
links
](
#anchor-links
)
within the page, but m
ay
also affect links to the
only
[
links
](
#anchor-links
)
within the page, but m
ight
also affect links to the
GitLab documentation from both the GitLab application and external sites.
GitLab documentation from both the GitLab application and external sites.
### Anchor links
### Anchor links
...
@@ -1467,18 +1467,17 @@ guidelines, but for consistency you should try to use these values:
...
@@ -1467,18 +1467,17 @@ guidelines, but for consistency you should try to use these values:
### Note
### Note
Notes indicate
information that is of special use to the reader, and
are most
Notes indicate
additional information that is of special use to the reader. Notes
are most
effective when used _sparingly_.
effective when used _sparingly_.
The goal for notes is to not use them at all. If, however, a note is truly
Try to avoid them. Too many notes can impact the scannability of a topic and create an overly busy page.
required, do not use more than _two_ notes per documentation page.
Instead of a note, try one of these alternatives:
Instead of a
dding a
note, try one of these alternatives:
-
Re-write the sentence as part of the most-relevant
-
Re-write the sentence as part of the most-relevant
paragraph.
paragraph.
-
Put the information into its own standalone paragraph.
-
Put the information into its own standalone paragraph.
-
Put the content under a new subheading that introduces the topic
. This
makes it more
-
Put the content under a new subheading that introduces the topic
, which
makes it more
visible.
visible.
If you must use a note, use the following formatting:
If you must use a note, use the following formatting:
...
...
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