apache/airflow

Generate a mermaid diagram for the database ERD schema

Open

#36,842 opened on Jan 17, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (16,781 forks)batch import
good first issuekind:documentationkind:task

Repository metrics

Stars
 (44,809 stars)
PR merge metrics
 (Avg merge 7d 18h) (834 merged PRs in 30d)

Description

Description

The docs currently show Airflow's database ERD schema as an image: https://airflow.apache.org/docs/apache-airflow/stable/database-erd-ref.html. To make this searchable, it would be useful to visualize this using mermaid, which also supports ERD schemas: https://mermaid.js.org/syntax/entityRelationshipDiagram.html.

Use case/motivation

Would be useful to make text in the database diagram searchable.

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Contributor guide

Research direction
Investigate the existing database ERD schema in Airflow and create a mermaid diagram for it.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitDatabase schema understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70