Commit 815a8dc5 authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-version-history-formatting' into 'master'

Clarify version text formatting

See merge request gitlab-org/gitlab!55340
parents b64399da 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:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment