Commit 5d5fed39 authored by Craig Norris's avatar Craig Norris

Merge branch 'sselhorn-master-patch-33036' into 'master'

Added details about words the version bullet must include

See merge request gitlab-org/gitlab!56388
parents afa1e4d6 8ec4f9da
...@@ -1611,11 +1611,12 @@ If all content in a section is related, add version text after the header for ...@@ -1611,11 +1611,12 @@ If all content in a section is related, add version text after the header for
the section. The version information must: the section. The version information must:
- Be surrounded by blank lines. - Be surrounded by blank lines.
- Start with `>`. - Start with `>`. If there are multiple bullets, each line must start with `> -`.
- Version histories with more than one entry should have each entry on its own - The string must include these words in this order (capitalization doesn't matter):
line (long lines are okay). Start each line with `> -` to get unordered list - `introduced`, `deprecated`, `moved`
formatting. - `in` or `to`
- Whenever possible, have a link to the completed issue, merge request, or epic - `GitLab`
- Whenever possible, include a link to the completed issue, merge request, or epic
that introduced the feature. An issue is preferred over a merge request, and that introduced the feature. An issue is preferred over a merge request, and
a merge request is preferred over an epic. a merge request is preferred over an epic.
......
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