potiuk commented on code in PR #36333: URL: https://github.com/apache/airflow/pull/36333#discussion_r1432996058
########## CONTRIBUTING.rst: ########## @@ -981,6 +981,58 @@ Documentation for ``apache-airflow`` package and other packages that are closely providers packages are in ``/docs/`` directory. For detailed information on documentation development, see: `docs/README.rst <docs/README.rst>`_ +Diagrams +======== + +We started to use (and gradually convert old diagrams to use it) `Diagrams <https://diagrams.mingrammer.com/>`_ +as our tool of choice to generate diagrams. The diagrams are generated from Python code and can be +automatically updated when the code changes. The diagrams are generated using pre-commit hooks (See +static checks below) but they can also be generated manually by running the corresponding Python code. + +To run the code you need to install the dependencies in the virtualenv you use to run it: +* ``pip install diagrams rich`` + +You need to have graphviz installed in your system (``brew install graphviz`` on macOS for example). + +The source code of the diagrams are next to the generated diagram, the difference is that the source +code has ``.py`` extension and the generated diagram has ``.png`` extension. The pre-commit hook +we have ``generate-airflow-diagrams`` will look for ``diagram_*.py`` files in the directories where it Review Comment: Resoleved. -- 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]
