Skip to content

Propose ownership metadata for API pages

Amy Qualls requested to merge aqualls-api-metadata into master

What does this MR do?

Proposes stage and group ownership for the following API pages, based mostly off of the stage / groups responsible for the issues or MRs referenced in the "introduced in" lines on the page:

  • doc/api/appearance.md - Manage :: Access (@mjang1)
  • doc/api/dependency_proxy.md - Package :: Package (@sselhorn)
  • doc/api/epic_links.md - Plan :: Project Management (@msedlakjakubowski)
  • doc/api/geo_nodes.md - Enablement :: Geo (@axil)
  • doc/api/group_activity_analytics.md - Manage :: Optimize (@mjang1)
  • doc/api/group_import_export.md - Manage :: Import (@mjang1)
  • doc/api/notes.md - Plan :: Project Management (@msedlakjakubowski)
  • doc/api/personal_access_tokens.md - Manage :: Compliance (@mjang1)

Related issues

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.
Edited by Amy Qualls

Merge request reports