Skip to content

Full revision of Changes page

Amy Qualls requested to merge aqualls-revise-changes into master

What does this MR do?

This merge request handles the revision of https://docs.gitlab.com/ee/user/project/merge_requests/changes.html - some months ago this page had to be created because these sections had to be chopped out of other pages to make them single-topic and CTRT-compliant, but this page needed a full and thoughtful rewrite after the information was compiled together.

  • Remove old images
  • Reshoot a single, better image
  • Rename subheadings
  • Combine more subheadings into the top 'concept' section
  • Rebuild the version history of every section that had a feature flag at some time in the past
  • Rewrite pretty much everything
  • Readability: 6.72 before, 6.24 after.

Related issues

Related to technical-writing#503 (closed) which is the OKR issue 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