Skip to content

Fix mermaid syntax errors in documentation pages

Peter Leitzen requested to merge pl-fix-invalid-mermaid into master

What does this MR do and why?

This MR fixes mermaid "Syntax errors" as described in #441233 (closed).

Two errors are due to the use of <br/> in an unquoted argument to subgraph. Quoting the argument is sufficient to resolve this issue.

See #441248 (closed) how we plan to prevent future failures.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Before After
Screenshot_from_2024-02-09_13-46-27 Screenshot_from_2024-02-09_13-49-28
Screenshot_from_2024-02-09_13-46-17 Screenshot_from_2024-02-09_13-49-11
Screenshot_from_2024-02-09_13-45-34 Screenshot_from_2024-02-09_13-49-00

How to set up and validate locally

npm install -g @mermaid-js/mermaid-cli

mmdc -i doc/development/gitlab_flavored_markdown/specification_guide/index.md  -o /tmp/foo.svg

mmdc -i doc/architecture/blueprints/gitlab_services/index.md  -o /tmp/foo.svg

# No failures
Edited by Peter Leitzen

Merge request reports