Skip to content

Move CODEOWNERS syntax reference to a child page

Amy Qualls requested to merge 396315-aqualls-split-out-errors into master

What does this MR do?

I needed to merge the large reference-style contributions from @jwoodwardgl rather quickly as part of the two related issues listed below, to keep him moving on his milestone goals. I knew the docs cleanup would be gnarly, and he didn't need to be involved in it.

The addition of large syntax and error-handling portions to an already-overloaded CODEOWNERS page just wasn't going to work long-term. They needed to be in a child page (pages?) of doc/user/project/code_owners.md, but I needed a new subdirectory to build a place for it. !117061 (merged) moved the file from doc/user/project/code_owners.md to doc/user/project/codeowners/index.md, so this work would have a home.

Now the disclaimer for the docs reviewer: 🙈 the original page (now doc/user/project/codeowners/index.md) is still a hot mess. It's been a hybrid of user docs and syntax documentation for longer than I've been part of Create, and this MR doesn't finish the work. You'll find syntax-related instructions all over the page, still. My goal with this merge request is to find a manageable MVC that I can land before the 16th, so the page and its nav entry will appear in the %15.11 release. After this merge request, I can start spinning up parallel (smaller!) merge requests to start work on cleaning up individual subheadings.

Related issues

Author's checklist

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 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.
Edited by Amy Qualls

Merge request reports