Skip to content

Squash and merge page - CTRT revisions

Amy Qualls requested to merge aqualls-squash-merge-big-revision into master

What does this MR do?

I've been chipping away at the changes to doc/user/project/merge_requests/squash_and_merge.md for a while, and I need to post them in MR form so I can get other eyes on them. I'm starting to lose objectivity.

Readability

  • Prior to starting edits, the reading score was 13.37.
  • Midpoint: 13.33.
  • When assigning over to Suzanne: 12.95.

Related issues

Related to technical-writing#503 (closed) (the OKR for the quarter)

Author's checklist

If you are 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.

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 reviews above. 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

Loading