Skip to content

Repair diagram by taking it out of the list

Amy Qualls requested to merge aqualls-fix-malformed-diagram into master
  • Please check this box if this contribution uses AI-generated content as outlined in the GitLab DCO & CLA.

What does this MR do?

I noticed this Kramdown warning, and wanted to fix it:

kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/architecture/blueprints/cells/infrastructure/index.md name=default>
  Found invalidly used HTML closing tag for 'details' on line 302 - ignoring it
  Found no end tag for 'gcp' on line 282 - auto-closing it

      create  [0.04s]  public/ee/architecture/blueprints/cells/impacted_features/your-work.html
      create  [0.07s]  public/ee/architecture/blueprints/cells/index.html

In doc/architecture/blueprints/cells/infrastructure/index.md, there was a diagram, wrapped in a <details> tag, as part of an unordered list. This MR tries to remove SOME of the wrappers by taking out the unordered list. Maybe the diagram will render with this fix?

Steps to reproduce

  1. Go to https://docs.gitlab.com/ee/architecture/blueprints/cells/infrastructure/index.html#architecture
  2. Twirl down KAS: Select to Expand
  3. See raw Mermaid markup.

Related issues

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