Commit c8efe0e8 authored by Susan Tacker's avatar Susan Tacker

Update Note description in styleguide.md

parent 5b59ffcf
...@@ -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 may also affect links to the only [links](#anchor-links) within the page, but might 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 adding 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:
......
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