[dennysreg]

Closes: #36842

Use paracelsus to generate the docs/apache-airflow/img/airflow_erd.svg file based on SQLAlchemy models.

NOTE: The same tool could be use to generate a mermaid code and inject it to a Markdown file but it seems like rst format is not supported yet.

Before

After

---

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

[boring-cyborg]

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

• Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
• In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
• Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
• Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
• Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
• Be sure to read the Airflow Coding style.
• Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
  Apache Airflow is a community-driven project and together we are making it better 🚀.
  In case of doubts contact the developers at:
  Mailing List: dev@airflow.apache.org
  Slack: https://s.apache.org/airflow-slack

[uranusjr]

Is it necessary to put this in README? I’m not sure that’s particularly useful TBH…

[dennysreg]

Not really, we should find a better place to embed it. It was just the first markdown file I found. Any suggestions?

[uranusjr]

The user-facing documentation already has an image, so maybe somewhere in contributing-docs? IIRC there’s a document there on database models.

[dennysreg]

Unfortunately I can't inject the mermaid in the rst file so I just replace the svg file instead
and restore the original README
https://github.com/dennysreg/airflow/blob/issue-36842-generate-a-mermaid-erd-diagram-from-sqlalchemy-models/docs/apache-airflow/database-erd-ref.rst

[potiuk]

@dennysreg - do you think you can rebase it and make it ready to be merged?

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.