Commit 65be17fe authored by Mike Lewis's avatar Mike Lewis

Merge branch 'eread/add-additional-version-text-guidance' into 'master'

Add further guidance when documenting versions

See merge request gitlab-org/gitlab!20940
parents b486ee40 b21e8dc6
...@@ -1244,6 +1244,20 @@ a helpful link back to how the feature was developed. ...@@ -1244,6 +1244,20 @@ a helpful link back to how the feature was developed.
NOTE: **Note:** NOTE: **Note:**
Version text must be on its own line and surounded by blank lines to render correctly. Version text must be on its own line and surounded by blank lines to render correctly.
### Versions in the past or future
When describing functionality available in past or future versions, use:
- **Earlier**, and not **older** or **before**.
- **Later**, and not **newer** or **after**.
For example:
- Available in GitLab 12.3 and earlier.
- Available in GitLab 12.4 and later.
- If using GitLab 11.4 or earlier, ...
- If using GitLab 10.6 or later, ...
### Importance of referencing GitLab versions and tiers ### Importance of referencing GitLab versions and tiers
Mentioning GitLab versions and tiers is important to all users and contributors Mentioning GitLab versions and tiers is important to all users and contributors
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment