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
710ba771
Commit
710ba771
authored
Mar 01, 2021
by
Marcel Amirault
Committed by
Craig Norris
Mar 01, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clarify version text formatting
parent
446fc0e5
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
16 additions
and
19 deletions
+16
-19
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+16
-19
No files found.
doc/development/documentation/styleguide/index.md
View file @
710ba771
...
...
@@ -1607,34 +1607,31 @@ displayed for the page or feature.
#### Version text in the **Version History**
If all content in a section is related, add version text after the header
for the section. The version information must be surrounded by blank lines, and
each entry should be on its own line.
Add the version history information as a blockquote:
If all content in a section is related, add version text after the header for
the section. The version information must:
-
Be surrounded by blank lines.
-
Start with
`>`
.
-
Version histories with more than one entry should have each entry on its own
line (long lines are okay). Start each line with
`> -`
to get unordered list
formatting.
-
Whenever possible, have a link to the completed issue, merge request, or epic
that introduced the feature. An issue is preferred over a merge request, and
a merge request is preferred over an epic.
```
markdown
## Feature name
>
Introduced
in GitLab 11.3.
>
[Introduced](<link-to-issue>)
in GitLab 11.3.
This feature does something.
```
Whenever possible, version text should have a link to the completed issue, merge
request, or epic that introduced the feature. An issue is preferred over a merge
request, and a merge request is preferred over an epic. For example:
```
markdown
> [Introduced](<link-to-issue>) in GitLab 11.3.
```
If you're adding information about new features or changes in a release, update
the blockquote to use a bulleted list:
## Feature name 2
```
markdown
> - [Introduced](<link-to-issue>) in GitLab 11.3.
> - Enabled by default in GitLab 11.4.
> - [Enabled by default](<link-to-issue>) in GitLab 11.4.
This feature does something else.
```
If a feature is moved to another tier:
...
...
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