Skip to content

Improve the TW structural check checklist

Why is this change being made?

Improve the Technical Writer's Structural check checklist, as a result of issues raised in the 13.11 Release Post retrospective:

  • Notate which checks are to be done in the review app, and which are to be done in a clone of the repository.
  • Ensure the TW lead has an up-to-date clone of the repository.

Note: I took the opportunity to remove some unwanted whitespace, and correct several spelling errors.

Author Checklist

  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
  • Assign this change to the correct DRI
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the "Maintained by" section in on the page being edited.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
    • If the changes relate to any part of the project other than updates to content and/or data files please make sure to ping @gl-static-site-editor in a comment for a review and merge. For example changes to .gitlab-ci.yml, JavaScript/CSS/Ruby code or the layout files. (this requirement has been removed pending identification of a new DRI for the handbook)
Edited by Russell Dickenson

Merge request reports