Skip to content

Fix Kramdown warnings in GraphQL defs and docs

Amy Qualls requested to merge 368320-aqualls-fix-kramdown into master

What does this MR do?

In Fix Kramdown Warnings in GraphQL documentation (#368320 - closed), @claytoncornell spotted some Kramdown warnings but was unsure how to fix them. I recognized both (I've dealt with these issues before) and thought I'd spin off a quick fix as one of the warnings was in my ~"group::editor" docset.

  • Fixes a malformed link in user/project/wiki/index.md
  • Fixes a malformed definition in ee/app/graphql/resolvers/dora_metrics_resolver.rb - note, this change will need backend review from a backend engineer, though it should be trivial

Related issues

Closes #368320 (closed)

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