Skip to content

Improve documentation MR description template

Marcia Ramos requested to merge docs-improve-mr-template into master

What does this MR do?

After we changed the MR description template "Documentation", we have missed some important checklist items, such as:

  • Add the product badges
  • Add the GL tier and version a feature was introduced in
  • Submit EE MR when ee-compat-check fails
  • Apply the devops and product labels to the MR
  • Apply the label "Pick into" and "Missed deliverable" when the feature freeze has passed
  • Different checklist items for linking indexes and related docs
  • The author should set the milestone, not the reviewer
  • Merge EE first, CE later
  • Remove the line to add the "documentation" label, since there's a slash command doing it already at the end of the MR description template.

This MR adds them back and specifies some items.

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

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports