Skip to content

Update old link in structure of GraphQL API page

Amy Qualls requested to merge aqualls-fix-pagination-arguments into master

What does this MR do?

@eread and @marcel.amirault have been trying to stand up a new link checker (Slack discussion) and ran into problems in !145471 (merged) because of a failed link.

The problem in https://gitlab.com/gitlab-org/gitlab/-/jobs/6230007237 was this link, repeated hundreds of times:

doc/api/graphql/reference/index.md:34897:15 MD051/link-fragments 
  Link fragments should be valid 
  [Context: "[pagination arguments](#connection-pagination-arguments)"]

I went trawling and found it's just one link in the template, but it's repeated over and over:

  • tooling/graphql/docs/helper.rb
  • tooling/graphql/docs/templates/default.md.haml

The template is trying to provide a custom link, and I don't see a reason why. (We should definitely get a backend engineer to double-check.) If we fix the link in the template, we should be able to fix the GraphQL reference page.

Related issues

Related to Turn on link-fragments Markdownlint check (!145471 - merged)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Amy Qualls

Merge request reports