diff options
| author | Evan Read <eread@gitlab.com> | 2018-09-25 13:09:16 +1000 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2018-09-25 14:26:12 +1000 |
| commit | 7286fde9f22988b9383b83ba69acc8c34749bd83 (patch) | |
| tree | cd72053109093b1ef8c40354943806581130c129 | |
| parent | f407bbf352c1169dc4fcc47e6b5341ec2cec7fe2 (diff) | |
| download | gitlab-ce-docs/version-and-tiers-guidance.tar.gz | |
Refine text from review commentsdocs/version-and-tiers-guidance
| -rw-r--r-- | doc/development/documentation/styleguide.md | 29 |
1 files changed, 17 insertions, 12 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 3355c1203cd..d4f7bb7ae74 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -251,24 +251,29 @@ below. (in that order) that introduced it. The above quote would be then transformed to: ```md - > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/1242) in GitLab 8.3. + > [Introduced](<link-to-issue>) in GitLab 8.3. ``` -#### Enterprise Edition +- If the feature is only available in GitLab Enterprise Edition, don't forget to mention + the [paid tier](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers) + the feature is available in: -If the feature is only available in GitLab Enterprise Edition, the style depends on whether the feature predates or postdates the [introduction of tiers in 9.2](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1851). + ```md + > [Introduced](<link-to-issue>) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.3. + ``` + +#### Early versions of EE -If the feature: +If the feature was created before GitLab 9.2 (before [different EE tiers were introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1851)): -- Postdates 9.2, mention the [paid tier](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers) the feature is available in. For example: - ```md - > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/1242) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.3. - ``` +- Declare it as "Introduced in GitLab Enterprise Edition X.Y". +- Note which tier the feature is available in. -- Predates 9.2, the style is similar to GitLab Community Edition. For example: - ```md - > [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/51) in GitLab Enterprise Edition 8.2. - ``` +For example: + +```md +> [Introduced](<link-to-issue>) in GitLab Enterprise Edition 9.0. Available in [GitLab Premium](https://about.gitlab.com/pricing/). +``` ### Product badges |