Fix markdown compile warning from stray chars
What does this MR do?
As part of the Kramdown fixes in !141317 (merged) I opted to NOT fix this warning, because I knew it would require a long pipeline to fix:
kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/api/graphql/reference/index.md name=default>
Found no end tag for 'Other' (line 6808) - auto-closing it
Found no end tag for 'Other' (line 1) - auto-closing it
(doc/api/graphql/reference/index.md
is compiled from GraphQL definitions, which meant the problem was in the backend, rather than in doc/
)
It's a small fix. The <Other projects>
string in line 28 of ee/app/graphql/mutations/ci/runners/export_usage.rb
should be in backticks, rather than straight quotes, so the parser won't try to do anything with it.
Related issues
Related to Resolve various Kramdown warnings (!141317 - merged) where I fixed the Kramdown warnings that did NOT require the long backend pipeline.
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.