Convert tutorial/architecture.png into a Graphviz Dot Diagram for Easy Maintainance
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 717
- Forks
- 1.2k
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 19
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate tutorial/architecture.png and inspect the repository's existing GitHub Actions workflows before planning the diagram-as-code setup. Define the architecture diagram in Graphviz DOT and ensure the workflow generates the PNG so future edits can be maintained as text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100