Skip to content

Fix malformed Markdown in subheading

Amy Qualls requested to merge docs-aqualls-patch-kas-title into master

What does this MR do?

Spotted this Kramdown warning; this MR fixes it:

      create  [0.02s]  public/ee/administration/geo/replication/disable_geo.html
kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/administration/clusters/kas.md name=default>
  Found no end tag for 'GITLAB_INTERNAL_IP' (line 130) - auto-closing it

In short: can't use unescaped < and > characters in Markdown, because Markdown thinks you're presenting a link.

Related issues

Related to !68703 (merged) where this warning was introduced - FYI to @marcia and @jfarmiloe.

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

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

Review 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.
    • 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports