diff options
| author | Evan Read <eread@gitlab.com> | 2019-05-02 09:55:41 +1000 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-05-02 09:55:41 +1000 |
| commit | c15adde9542466fe3aafa91a14526e01aac361eb (patch) | |
| tree | e4c1539d0cb9ce677b87debb41773157f3900966 | |
| parent | f7be93a871b7050f1a88df6cf74a032c684f4f01 (diff) | |
| download | gitlab-ce-docs/modify-versions-guidance.tar.gz | |
Final review feedback applieddocs/modify-versions-guidance
| -rw-r--r-- | doc/development/documentation/styleguide.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 19dd5b1153e..5caca846cc9 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -621,8 +621,8 @@ a helpful link back to how the feature was developed. > Introduced in GitLab 11.3. ``` -- Whenever possible, version text should have a link to the issue, merge request, or epic - (in order or preference) that introduced the feature. For example: +- Whenever possible, version text should have a link to the issue, merge request, or epic that introduced the feature. + An issue is preferred over a merge request, and a merge request is preferred over an epic. For example: ```md > [Introduced](<link-to-issue>) in GitLab 11.3. @@ -639,7 +639,7 @@ a helpful link back to how the feature was developed. ### Removing version text Over time, version text will reference a progressively older version of GitLab. In cases where version text -refers to versions of GitLab more than four major versions back, consider removing the text. +refers to versions of GitLab four or more major versions back, consider removing the text. For example, if the current major version is 11.x, version text referencing versions of GitLab 7.x and older are candidates for removal. |