Create initial subsection for TW rake task
What does this MR do?
Describe the tw::codeowners
rake task, and its problems. Document as much as
possible to hopefully enable others on the team to improve the Rake
task into something more automatable-ish.
Known follow-ups:
-
Discuss whether the metadata section in doc/development/documentation/index.md
is big enough to split off into a child page. -
After merge, add crosslink from the TW group onboarding template. -
Create an issue for two (relatively) small changes to the task output: stripping the leading dot on each line, and
Related issues
- Related to Document tw::codeowners rake task (technical-writing#598 - closed)
- Related to Create rake task for docs CODEOWNERS (!77715 - merged) where the rake task MVC was created
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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