2.4 KiB
2.4 KiB
What does this MR do?
Related issues
Author's checklist
- Follow the Documentation Guidelines and Style Guide.
- 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 of the format XX.Y is set. If the freeze for that release has begun, add the label
pick into <XX.Y>unless this change is not required for the release. In that case, simply change the milestone. - If EE and CE MRs exist, merge the EE MR first, then the CE MR.
- After merging, if there has not been a technical writer review, create an issue for one using the Doc Review template.
/label ~Documentation