Update and polish revert-MR template
What does this MR do?
In Improves revert-MR message (gitlab-org/ruby/gems/gitlab-dangerfiles!190 - merged) a technical writer (me!) is proposing improvements to the new revert-MR message shown in merge requests. @sselhorn pointed out that some of the information would be better placed in the revert template itself.
This merge request starts with two commits:
- !109529 (027966da) polishes the grammar and style of the existing template without introducing anything new. If the proposed improvements need to be reverted, we can at least preserve these fixes.
-
!109529 (e470bd7b) adds more information to the template:
- moves info about timing-sensitive label to the top
- adds checkboxes about version, and what to do with the
~"regression:*"
label - adds a related-links subheading, which felt like an oversight
Related issues
Blocks Improves revert-MR message (gitlab-org/ruby/gems/gitlab-dangerfiles!190 - merged)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
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. -
Ensure a release milestone is set. - 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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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 reviews above. Maintainer's review can occur before or after a technical writer review.