potiuk commented on code in PR #30650: URL: https://github.com/apache/airflow/pull/30650#discussion_r1167450389
########## airflow/METRICS.md: ########## Review Comment: Or maybe - we can find a better tool for the user-facing documentation ? The big value of mermaid is that it can be "close" to the code and github will render it during PRs and when you look at the code. I think @eladkal mentioned some time ago another diagramming tool we can use (can't remember) and if there is a sphinx plugin for example that we can use to generate such docs, and if it has a good free IDE support to render it locally (and allows for more types of user-type diagrams), then maybe we could use another tool? I tihnk mermaid is great for "internal development tool", but there are better alternatives for "user-facing" diagrams. Just a quick search revealed this for example: https://pypi.org/project/sphinx-diagrams/ where you can write Python code to generate architecture diagrams (which is even cooler if we can make diagrams as a Python code, which is precisely what Airflow does with workflows). Maybe we can find a tool that will fit better here? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
