Docs: explain why mentioning tiers and versions is important
What does this MR do?
This discussion came up several times through time. It's not obvious to all of us, GL contributors, why mentioning GL versions and tiers is important in the documentation.
This MR explains the importance of mentioning them and rewords the option to remove them when they become irrelevant.
Related issues
- Came up during the release post 12.7 review: gitlab-com/www-gitlab-com!37630 (diffs, comment 274282421)
- There's an upcoming MR removing quite some of them: !22955 (closed)
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcia Ramos