Skip to content

Docs: Update contributing pages with metadata

Craig Norris requested to merge docs-contrib-metadata into master

What does this MR do?

As part of our continuing efforts to ensure that documentation pages have metadata that helps contributors connect with TWs who can help them if they have issues, I've added the none/Style Guide stage/group identifier to the pages in the doc/development/contributing directory. Based on the content of the files, they're all about style guidance and other suggestions on how to add content to the product docs, so it made sense to bring them in to the Style Guide group's awareness. Over time, we could perhaps better integrate this information, and potentially cut down on any data replication. In the meantime, it'd give contributors a better understanding on how to connect with us if they have issues or questions.

I'm passing this along to the Style Guide group. If you have any questions or concerns, please let me know. Whenever you're all good with this change, feel free to approve and merge it. Thanks!

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.

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.
Edited by Craig Norris

Merge request reports

Loading