Diagrams

When you’ve to create diagrams, try to avoid native tools, and use open-source web-based solutions.

PlantUML

We’re running our own PlantUML Server to create our own PlantUML diagrams.

Note

The deployment, and all documentation for PlantUML can be found in the GitLab PlantUML project.

PlantUML documentation

Since the official docs are quite “adventurous” to understand, you might want to have a look at Ashley’s PlantUML Documentation. Some interesting chapters are:

• All Diagrams

• Formatting Diagrams with Skinparams, HTML, and Creole

• Color Names and Samples

• Creole Markup

• All Skin Parameters

The official documentation for PlantUML can be found here:

• PDF Guide (good for starting)

• PlantUML website

• Standard Library

• Language specification

• The Hitchhiker’s Guide to PlantUML

PlantUML & GitLab

GitLab supports inline PlantUML diagrams in GitLab Flavored Markdown.

PlantUML & Sphinx

You can also build PlantUML diagrams in your docs. Just have a look at the Documentation chapter.

draw.io

We’re running our own draw.io server to create our own draw.io diagrams.

Note

The deployment, and all documentation for draw.io can be found in the GitLab drawio project.