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
1f03ebb2
Commit
1f03ebb2
authored
Oct 02, 2020
by
Craig Norris
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs: Add in-line version guidance
parent
c119aa0b
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
23 additions
and
3 deletions
+23
-3
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+23
-3
No files found.
doc/development/documentation/styleguide.md
View file @
1f03ebb2
...
@@ -1636,6 +1636,15 @@ heading level.
...
@@ -1636,6 +1636,15 @@ heading level.
### Text for documentation requiring version text
### Text for documentation requiring version text
When a feature is new or updated, you can add version information as a bulleted
item in the
**Version history**
, or as an inline reference with related text.
#### Version text in the **Version History**
If all content in a section is related, add version text in a bulleted list
following the heading for the section. To render correctly, it must be on its
own line and surrounded by blank lines.
-
For features that need to declare the GitLab version that the feature was
-
For features that need to declare the GitLab version that the feature was
introduced. Text similar to the following should be added immediately below
introduced. Text similar to the following should be added immediately below
the heading as a blockquote:
the heading as a blockquote:
...
@@ -1685,9 +1694,20 @@ heading level.
...
@@ -1685,9 +1694,20 @@ heading level.
and replaced by
[
Feature name
](
link-to-feature-documentation
)
.
and replaced by
[
Feature name
](
link-to-feature-documentation
)
.
```
```
NOTE:
**Note:**
#### Inline version text
Version text must be on its own line and surrounded by blank lines to render
correctly.
If you're adding content to an existing topic, you can add version information
inline with the existing text.
In this case, add
`([introduced/deprecated](<link-to-issue>) in GitLab X.X)`
.
If applicable, include the paid tier:
`([introduced/deprecated](<link-to-issue>) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.4)`
Including the issue link is encouraged, but isn't a requirement. For example:
```
markdown
The voting strategy (introduced in GitLab 13.4) requires
the primary and secondary voters to agree.
```
### Versions in the past or future
### Versions in the past or future
...
...
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