Skip to content

Add type::maintenance label to docs MR template

Amy Qualls requested to merge aqualls-docs-template-add-labels into master

What does this MR do?

Adds the typemaintenance label to the merge request template for documentation. This label began use on 2021-10-27 (https://gitlab.slack.com/archives/C02PF508L/p1635320476040300).

The guidance for documentation MRs (https://about.gitlab.com/handbook/engineering/metrics/#documentation-go-forward-guidance) suggests:

  • typefeature for new feature documentation (this type would usually be already set on merge requests that introduce a new feature)
  • typemaintenance for any other documentation changes

My interpretation: most of the typefeature MRs will come to us with that label already in place, and the majority of the work created using this documentation template will be typemaintenance, we should consider adding this label by default.

Related issues

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"type::feature"
  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • 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.
Edited by Amy Qualls

Merge request reports