Skip to content

Update metadata for reporting in Secure index page

Craig Norris requested to merge docs-secure-metadata-update into master

What does this MR do?

For both our internal reporting and to help external stakeholders connect with TWs that can help them, we need to ensure that the stage/group values we enter map to literal values on the https://about.gitlab.com/handbook/engineering/ux/technical-writing/ page.

This MR updates the stage value for the page to Secure, and moves the page into an association with the Static Analysis group. I know that this page contains information from several Secure stage groups, but I chose this group because:

  • It was at the top of the list of Secure groups.
  • The Status Analysis group works with more tiers than the other Secure groups.

I also want to reiterate that adding a group to a doc page's metadata doesn't imply ownership of that page for a certain group. It's just a method to ensure that we have a knowledgeable TW associated with the page, to help internal and external content creators who encounter the page.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports

Loading