Skip to content

(docs) Update Airflow Plugin Documentation #55837

@cmarteepants

Description

@cmarteepants

What do you see as an issue?

With the plugin system enhancements being released in Airflow 3.1, while mvp information has been added, it is a good time to revisit plugin documentation to make it more comprehensive.

Solving the problem

Some things we should cover:

  • Explain what the plugin system is and why it matters
  • Available building blocks
    • External Views: Add buttons / tabs linking to new pages
    • React Apps: Embed custom react apps into the UI
    • FastAPI Apps: Add new API endpoints
    • Middlewares: Modify all API requests / responses
    • Macros: Functions usable in templates
    • Operator Extra Links: Custom buttons on task details
    • Timetables & Listeners: Custom scheduling & event hooks
  • Plugin management interface
  • Custom dashboard examples
  • External view iframe integration examples

Anything else

Related to #55521

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions