Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
sed-i opened this issue Aug 9, 2022 · 1 comment
Open

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

sed-i opened this issue Aug 9, 2022 · 1 comment

Comments

@sed-i
Copy link
Contributor

sed-i commented Aug 9, 2022

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
Copy link
Member

simskij commented Aug 9, 2022

Pinging @evildmp as he might have thoughts on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants