summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2018-07-25 11:30:24 +0000
committerMarcia Ramos <virtua.creative@gmail.com>2018-07-25 11:30:24 +0000
commitfe7c6bc699e502da30b765621915480c180afa24 (patch)
tree9537c3d717269a65fcae9eedbd9f290fc06f95a5
parent9aa07a7ec2d55ee2a7427eb77469e8e4b03eca06 (diff)
parent9982ff3f99286ecfb75171ab938b944db4e6823e (diff)
downloadgitlab-ce-fe7c6bc699e502da30b765621915480c180afa24.tar.gz
Merge branch 'docs/styleguide-versions' into 'master'
Prefer using direct links in docs styleguide See merge request gitlab-org/gitlab-ce!20832
-rw-r--r--doc/development/documentation/styleguide.md14
1 files changed, 6 insertions, 8 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index a315cfdc116..ad49c77aac8 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -219,28 +219,26 @@ below.
- 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:
+ blockquote:
```md
> Introduced in GitLab 8.3.
```
-- Whenever possible, every feature should have a link to the MR, issue, or epic that introduced it.
- The above note would be then transformed to:
+- Whenever possible, every feature should have a link to the issue, MR or epic
+ (in that order) that introduced it. The above quote would be then transformed to:
```md
- > [Introduced][ce-1242] in GitLab 8.3.
+ > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/1242) in GitLab 8.3.
```
- , where the [link identifier](#links) is named after the repository (CE) and
- the MR number.
-
- 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:
```md
- > [Introduced][ee-1234] in [GitLab Starter](https://about.gitlab.com/pricing/) 8.3.
+ > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/1242)
+ in [GitLab Starter](https://about.gitlab.com/pricing/) 8.3.
```
### Product badges