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

Convert tutorial/architecture.png into a Graphviz Dot Diagram for Easy Maintainance #2422

Open
conallob opened this issue Jan 23, 2024 · 0 comments

Comments

@conallob
Copy link

https://prometheus.io/assets/tutorial/architecture.png is a helpful diagram, but it's a static image which has to be edited in an external tool and added to git.

For easier maintainability, it could use Graphviz' DOT language to define the image in text and use GitHub Actions to generate the resulting PNG image. This pattern is sometimes known as Diagrams-as-Code, alongside Docs-as-Code.

I'm happy to contribute a PR to both create the Diagrams-as-Code CI setup and define the new architecture diagram

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

1 participant