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
2e6a02f8
Commit
2e6a02f8
authored
Sep 03, 2020
by
Suzanne Selhorn
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updated ephemeral heading sentence
Related to:
https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30672
parent
ba2f6dbc
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
2 additions
and
3 deletions
+2
-3
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+2
-3
No files found.
doc/development/documentation/styleguide.md
View file @
2e6a02f8
...
...
@@ -874,9 +874,8 @@ For other punctuation rules, please refer to the
someone in the Merge Request.
-
[
Avoid using symbols and special characters
](
https://gitlab.com/gitlab-org/gitlab-docs/-/issues/84
)
in headers. Whenever possible, they should be plain and short text.
-
Avoid adding things that show ephemeral statuses. For example, if a feature is
considered beta or experimental, put this information in a note, not in the
heading.
-
When possible, avoid including words that might change in the future. Changing
a heading changes its anchor URL, which affects other linked pages.
-
When introducing a new document, be careful for the headings to be
grammatically and syntactically correct. Mention an
[
assigned technical writer (TW)
](
https://about.gitlab.com/handbook/product/product-categories/
)
for review.
...
...
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