Skip to content

Update API template to include metadata

Amy Qualls requested to merge docs-aqualls-add-metadata-template into master

What does this MR do?

The TW team has been adding stage / group ownership metadata to all pages in issues stemming from &3991 (closed). However, we can't edit api/graphql/reference/index.md directly, because the output is controlled by a script. So … we need to update the script that generates it.

cc to @cnorris because he's spearheading the metadata effort.

I'm sending this over to @cablett because she knows the ins and outs of dealing with the GraphQL API page. (She may also have feelings about what stage / group owns the page!) I'm not sure what steps I might need to take to get this MR through to completion, but dropping in what we need is the best start.

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.

Merge request reports