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
1ba8376a
Commit
1ba8376a
authored
Dec 17, 2021
by
Marcin Sedlak-Jakubowski
Committed by
Suzanne Selhorn
Dec 17, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add guidance for granular version notes
parent
ba14ce92
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
0 deletions
+7
-0
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+7
-0
No files found.
doc/development/documentation/styleguide/index.md
View file @
1ba8376a
...
...
@@ -1653,6 +1653,13 @@ This feature does something.
This feature does something else.
```
If you're documenting elements of a feature, start with the feature name or a gerund:
```
markdown
> - Notifications for expiring tokens [introduced](<link-to-issue>) in GitLab 11.3.
> - Creating an issue from an issue board [introduced](<link-to-issue>) in GitLab 13.1.
```
If a feature is moved to another tier:
```
markdown
...
...
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