Skip to content

Link to user GraphQL guides from top-level README

Luke Duncalfe requested to merge ld-top-level-links-to-graphql-api into master

What does this MR do?

This MR provides links to user GraphQL guides from top-level README.

This improves the visibility of the GraphQL user documentation.

It was previously able to be accessed through the REST API docs, however, with the increasing maturity of the GraphQL API and GitLab's policy of GraphQL-first, this change makes the discovery of the GraphQL docs more easy.

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.

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 Luke Duncalfe

Merge request reports