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
a4a6de34
Commit
a4a6de34
authored
Dec 14, 2021
by
Evan Read
Committed by
Suzanne Selhorn
Dec 14, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add additional points of guidance for headings
parent
38b25e5d
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
3 additions
and
0 deletions
+3
-0
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+3
-0
No files found.
doc/development/documentation/styleguide/index.md
View file @
a4a6de34
...
...
@@ -792,6 +792,9 @@ This is overridden by the [documentation-specific punctuation rules](#punctuatio
for review, based upon the
[
product category
](
https://about.gitlab.com/handbook/product/categories/
)
.
This is to ensure that no document with wrong heading is going live without an
audit, thus preventing dead links and redirection issues when corrected.
-
Use the context provided by parent section headings. That is, don't repeat the parent heading's text in each
subsection's heading.
-
Use articles and prepositions in headings where it would make sense in regular text.
-
Leave exactly one blank line before and after a heading.
-
Do not use links in headings.
-
Add the corresponding
[
product badge
](
#product-tier-badges
)
according to the tier the
...
...
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