Skip to content

Create faux group for Tutorials, update pages

Amy Qualls requested to merge aqualls-make-faux-tutorials-group into master

What does this MR do?

Kati would like to be pinged on changes in the doc/tutorials folder. Manual changes to the TW portion of the CODEOWNERS file are unlikely to persist after someone performs the update steps listed at https://docs.gitlab.com/ee/development/documentation/#batch-updates-for-tw-metadata.

The easiest approach would be to add a faux group for Tutorials, assign it to Kati in the Rake task, and her request will persist. This change would have a small ripple effect on Suzanne's content audit spreadsheet, but from a Slack discussion this morning, it sounds minimal.

Related issues (original)

Related issues

These issues and MRs describe the evolution of the CODEOWNERS project for the Technical Writing team, from the initial idea through multiple (!) iterations to a finished product. These links may have been added significantly after this issue or merge request was closed, so they may describe parts of the process before or after this work.

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 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