Fix TW metadata on Omnibus pages
What does this MR do?
Metadata fixes for the documentation pages:
- Updates the metadata URL pointing to the technical writer assignments, as the
engineering
slug changed toproduct
as part of the September 2022 realignment: https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments - Adds metadata to these pages, which were missing metadata entirely. (@eread / @marcel.amirault - another repo we should consider adding a missing-metadata check to.)
doc/development/broken_master.md
doc/development/upgrading-chef.md
doc/development/vulnerabilities.md
- In the case of pages belonging to groupdistribution, corrects the stage name from
Enablement
toSystems
.
Related issues
- Related to https://gitlab.com/gitlab-com/www-gitlab-com/-/issues/13984+
- Related epic: https://gitlab.com/groups/gitlab-com/-/epics/1940+
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are only adding documentation, do not add any of the following labels:
~"feature"
~"frontend"
~"backend"
~"bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Review 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. - 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 above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.
Edited by Amy Qualls