summaryrefslogtreecommitdiff
path: root/doc/development/documentation/styleguide.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-03-24 03:09:28 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-03-24 03:09:28 +0000
commitbe2f4c5788975597dd7be1c8a3525549770c1216 (patch)
tree083ed0d7e29e26d479c00e00d9cb89d74ebbb0ef /doc/development/documentation/styleguide.md
parent2711c26beaca6c3a5a3be4b65e01557faf0185b6 (diff)
downloadgitlab-ce-be2f4c5788975597dd7be1c8a3525549770c1216.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide.md')
-rw-r--r--doc/development/documentation/styleguide.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index 23faeed13a3..f2b59b60fe6 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -1132,26 +1132,28 @@ a helpful link back to how the feature was developed.
- For features that need to declare the GitLab version that the feature was introduced. Text similar
to the following should be added immediately below the heading as a blockquote:
-
- ```md
- > Introduced in GitLab 11.3.
- ```
+ - `> Introduced in GitLab 11.3.`.
- Whenever possible, version text should have a link to the 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:
-
- ```md
- > [Introduced](<link-to-issue>) in GitLab 11.3.
- ```
+ - `> [Introduced](<link-to-issue>) in GitLab 11.3.`.
- If the feature is only available in GitLab Enterprise Edition, mention
the [paid tier](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers)
the feature is available in:
+ - `> [Introduced](<link-to-issue>) in [GitLab Starter](https://about.gitlab.com/pricing/) 11.3.`.
+
+- If listing information for multiple version as a feature evolves, add the information to a
+ block-quoted bullet list. For example:
```md
- > [Introduced](<link-to-issue>) in [GitLab Starter](https://about.gitlab.com/pricing/) 11.3.
+ > - [Introduced](<link-to-issue>) in GitLab 11.3.
+ > - Enabled by default in GitLab 11.4.
```
+NOTE: **Note:**
+Version text must be on its own line and surounded by blank lines to render correctly.
+
### Importance of referencing GitLab versions and tiers
Mentioning GitLab versions and tiers is important to all users and contributors