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

Default diagrams tool for RFCs #35

Open
thiagocaiubi opened this issue Aug 12, 2021 · 1 comment
Open

Default diagrams tool for RFCs #35

thiagocaiubi opened this issue Aug 12, 2021 · 1 comment

Comments

@thiagocaiubi
Copy link
Contributor

You can use any tool for that: draw.io, Mermaid, Miro, or a simple picture of a physical white board taken by your phone.

https://github.com/barbosa/culture/blame/main/architecture/README.md#L7

Since https://github.com/loadsmart/rfcs/pull/197 got approved, I think we should evaluate the impact of requiring kroki as the only allowed tool for diagrams in RFCs. Kroki already supports multiple diagrams.

The motivation behind this is mostly based on the source code for diagrams living together with the rest of the documentation. That would leverage the maintainability and would avoid missing permissions with different services out there.

@barbosa
Copy link
Contributor

barbosa commented Aug 12, 2021

That's a good point, @thiagocaiubi.

draw.io and Miro could bring those permission issues indeed.

An image could live together with the file in the repo but using diagram-as-code could be ideal.

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