summaryrefslogtreecommitdiff
path: root/doc/development/doc_styleguide.md
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-08-08 11:09:54 +0300
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-08-08 11:44:55 +0300
commit689de9c6fbae36979536ce221051273e017786da (patch)
tree3f234fd117a2955179f28b9e9060fe1ac0455b42 /doc/development/doc_styleguide.md
parent91030230545a199a86c2742600a7a2e68ef75c98 (diff)
downloadgitlab-ce-689de9c6fbae36979536ce221051273e017786da.tar.gz
Simplify feature introduction notesimplify_intro_features_doc
[ci skip]
Diffstat (limited to 'doc/development/doc_styleguide.md')
-rw-r--r--doc/development/doc_styleguide.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index da6b7686427..994005f929f 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -155,15 +155,15 @@ Inside the document:
- 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: `>**Note:** This feature was introduced in GitLab 8.3`
+ note: `> Introduced in GitLab 8.3.`.
- If possible every feature should have a link to the MR that introduced it.
The above note would be then transformed to:
- `>**Note:** This feature was [introduced][ce-1242] in GitLab 8.3`, where
+ `> [Introduced][ce-1242] in GitLab 8.3.`, where
the [link identifier](#links) is named after the repository (CE) and the MR
- number
+ number.
- If the feature is only in GitLab EE, don't forget to mention it, like:
- `>**Note:** This feature was introduced in GitLab EE 8.3`. Otherwise, leave
- this mention out
+ `> Introduced in GitLab EE 8.3.`. Otherwise, leave
+ this mention out.
## References