Add + comment out groups routed to #docs
What does this MR do?
As part of the Technical Writing team meeting on 2023-03-08, let's make our lives a little bit easier. For groups that recently lost a named technical writer, and are now routed to the #docs channel, leave the group names in the array but comment them out. A commented-out line is a more obvious negative than a missing line, which could imply "no writer" or "oops we forgot this group."
Notes:
- There's one other one-off change here, and a couple of alphabetical-order fixes, as well. I'll note it in the comments.
- https://about.gitlab.com/handbook/product/categories/#devops-stages contains the list of groups that are to be routed to #docs.
- I skipped the changes to the devopsgovern groups based on Diana's comment 2d in the team meeting notes. Those will be handled in Transition Govern/Threat Insights to Russell Di... (technical-writing#762 - closed) and Transition Govern/Security Policies to Russell ... (technical-writing#761 - closed)
Related issues
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 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 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.