diff options
| author | Marcia Ramos <virtua.creative@gmail.com> | 2018-09-25 11:38:51 +0000 |
|---|---|---|
| committer | Marcia Ramos <virtua.creative@gmail.com> | 2018-09-25 11:38:51 +0000 |
| commit | 959386eb0c11c1a4f71faf1eff8ea837b13a4c0d (patch) | |
| tree | 9ff49b2ac88aef22e92c1672a00952c04ffb0fdb | |
| parent | a1ee365843dccc265557904051e8bd51d5f54488 (diff) | |
| parent | d68ee3cea87e3e29c75c845887e234f973e8158d (diff) | |
| download | gitlab-ce-959386eb0c11c1a4f71faf1eff8ea837b13a4c0d.tar.gz | |
Merge branch 'docs/version-and-tiers-guidance' into 'master'
Add clarity to EE feature styles for features introduced before and after 9.2
See merge request gitlab-org/gitlab-ce!21874
| -rw-r--r-- | doc/development/documentation/styleguide.md | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 8083f219d4a..d4f7bb7ae74 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -251,7 +251,7 @@ 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. ``` - If the feature is only available in GitLab Enterprise Edition, don't forget to mention @@ -259,10 +259,22 @@ below. the feature is available in: ```md - > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/1242) - in [GitLab Starter](https://about.gitlab.com/pricing/) 8.3. + > [Introduced](<link-to-issue>) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.3. ``` +#### Early versions of EE + +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)): + +- Declare it as "Introduced in GitLab Enterprise Edition X.Y". +- Note which tier the feature is available in. + +For example: + +```md +> [Introduced](<link-to-issue>) in GitLab Enterprise Edition 9.0. Available in [GitLab Premium](https://about.gitlab.com/pricing/). +``` + ### Product badges When a feature is available in EE-only tiers, add the corresponding tier according to the |