summaryrefslogtreecommitdiff
path: root/doc/development/doc_styleguide.md
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2018-02-22 16:13:35 +0000
committer🚄 Job van der Voort 🚀 <job@gitlab.com>2018-02-22 16:13:35 +0000
commit650d11beb44106de6fa399c53540fc15e1bd06bb (patch)
tree88e8dfeb9e34c9f461cba8903f3ce2df9dcef2c2 /doc/development/doc_styleguide.md
parent05f4788eab747d2529ebf2b7a3dd3e1ee2385fa3 (diff)
downloadgitlab-ce-650d11beb44106de6fa399c53540fc15e1bd06bb.tar.gz
Docs: search/replace "Enterprise Edition" and adjust when applicable
Diffstat (limited to 'doc/development/doc_styleguide.md')
-rw-r--r--doc/development/doc_styleguide.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index cfeeed2506d..6fe5f647d6c 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -236,6 +236,11 @@ Inside the document:
## New features
+New features must be shipped with its accompanying documentation and the doc
+reviewed by a technical writer.
+
+### Mentioning GitLab versions and tiers
+
- Every piece of documentation that comes with a new feature should declare the
GitLab version that feature got introduced. Right below the heading add a
note:
@@ -244,7 +249,7 @@ Inside the document:
> Introduced in GitLab 8.3.
```
-- If possible every feature should have a link to the MR that introduced it.
+- If possible every feature should have a link to the MR, issue, or epic that introduced it.
The above note would be then transformed to:
```
@@ -254,11 +259,12 @@ Inside the document:
, where the [link identifier](#links) is named after the repository (CE) and
the MR number.
-- If the feature is only in GitLab Enterprise Edition, don't forget to mention
- it, like:
+- 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:
```
- > Introduced in GitLab Enterprise Edition 8.3.
+ > [Introduced][ee-1234] in [GitLab Starter](https://about.gitlab.com/products/) 8.3.
```
Otherwise, leave this mention out.