Skip to content

Docs: Update TW Handbook to add CODEOWNERS update responsibility

Craig Norris requested to merge docs-add-codeowner-workflow-handbook into master

Why is this change being made?

Updating the TW Handbook to ensure that updating the CODEOWNERS file is a requirement by TWs whenever working on or with doc pages.

My goal was to include this is one of the responsibilities of the TW as part of their process, and as such, decided it fit best within the Technical Writing workflows page at: https://about.gitlab.com/handbook/engineering/ux/technical-writing/workflow/#technical-writers

I see this as an MVC to ensure that the team has this listed as one of their responsibilities, and if additional information is required to instruct people on how to make any needed changes, that can be handled separately.

Closes gitlab-org/technical-writing#168 (closed)

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][transparency]
  • Assign this change to the correct DRI
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to your manager.
    • 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][mr-buddies-slack].
    • 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.

Technical Writing handbook

Merge request reports