canonical / charmhub.io

GNU General Public License v3.0
9 stars 22 forks source link

Add support for mermaid diagrams in charm/lib docs #1384

Open sed-i opened 2 years ago

sed-i commented 2 years ago

As the ecosystem grows it becomes valuable to convey information in diagrams.

At the moment, the observability team uses mermaid to outline charm deployment scenarios, for example:

Other examples:

Mermaid is plain-text so easily diffed/bisected/etc.

Needing to upload .png to discourse means we need to keep the source somewhere, which means overlap between github .md docs and discourse docs, which we'd need to merge manually both ways every time we need to update.

We would be able to better use discourse and reduce overlap between github *.md and discourse posts if charmhub and discourse supported mermaid.

simskij commented 2 years ago

Pinging @evildmp as he might have thoughts on this.