Update Mermaid 11 incompatible diagrams
-
Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA. As a benefit of being a GitLab Community Contributor, you receive complimentary access to GitLab Duo.
What does this MR do and why?
Update Mermaid 11 incompatible diagrams
Applies the suggested workarounds for the 4 known rendering issues documented in #554889. The updated documents should render acceptably in both Mermaid 10.x as well as 11.x.
More specifically, the intent of this MR is to update the diagrams so that this project could upgrade to Mermaid 11.x without breaking any diagrams distributed within this project.
References
Issue #554889 documents the issues this MR is attempting to resolve.
How to set up and validate locally
These changes only affect mermaid diagrams in the documentation. Viewing the affected diagrams on GitLab.com should show that they are still rendered as expected in 10.7. To validate that the diagrams also render acceptably in 11.x, one would first have to create a local build using Mermaid 11.x. This MR does not yet attempt to upgrade the Mermaid dependency.
Additionally, a reviewer may be interested in the test site I deployed at https://ajuckel.gitlab.io/mermaid-test/ to investigate these rendering issues.
MR acceptance checklist
Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.