Skip to content

Find a suitable tool for creation of complex diagrams in the GitLab documentation

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Consider this description a DRAFT. The "Problem to solve" statement needs to be more specific and detailed. That can be gained by evaluating the example Mermaid diagrams included in this issue.

Problem to solve

The GitLab Documentation Style Guide states that the Mermaid tool is to be used where possible to create diagrams for use in the documentation. The Mermaid has several advantages over screenshots, including easier maintenance and the scalable image format. However, it also has a significant disadvantage: the diagram's layout is determined at render time. As a result, the layout and presentation of complex diagrams is suboptimal, including elements overlapping.

Proposal

Research and test alternatives to Mermaid. The result should be the selection of a tool that can be used in place of Mermaid when that tool's output is not suitable. The aim is not to find a replacement for Mermaid.

Who can address the issue

Anyone.

Other links/references

Edited by 🤖 GitLab Bot 🤖