diff --git a/doc/development/documentation/versions.md b/doc/development/documentation/versions.md index 1adee1f0999edc03c8e24a63501557fbd96e22ec..ec3a43707fb205f1b09098f8e12c0c009df0a309 100644 --- a/doc/development/documentation/versions.md +++ b/doc/development/documentation/versions.md @@ -42,19 +42,22 @@ For example: This feature does something. ``` -The item text should include these words in order. Capitalization doesn't matter. +The item text must include these words in order. Capitalization doesn't matter. - `introduced`, `enabled`, `deprecated`, `changed`, `moved`, `recommended`, `removed`, or `renamed` - `in` or `to` - `GitLab` (or, for external projects, the name of the project) -If you cannot use this format, you can use different language. Try to be -consistent with other notes on the page, or other notes on the docs site. +The docs site uses [Ruby code](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/lib/filters/introduced_in.rb) +to render the notes based on these words. -If possible, include a link to the related issue, merge request, or epic. -Do not link to the pricing page. Do not include the subscription tier. +In addition: -Even if you have only one item, ensure it begins with `> -`. +- Try to be consistent with other notes on the page, or other notes on the docs site. +- Ensure that the output generates properly. +- If possible, include a link to the related issue, merge request, or epic. +- Do not link to the pricing page. Do not include the subscription tier. +- Even if you have only one item, ensure it begins with `> -`. #### Introducing a new feature