Skip to content

Conversation

@Lohith625
Copy link
Contributor

Overview

This PR improves the plugin system documentation for Airflow by:

  • Adding a clear explanation of what the plugin system is and why it matters.
  • Listing available building blocks (External Views, React Apps, FastAPI Apps, Middlewares, Macros, Operator Extra Links, Timetables, Listeners).
  • Including examples for plugin management interface and external view iframe integration.
  • Making the documentation more comprehensive and beginner-friendly.

Motivation

With the plugin system enhancements released in Airflow 3.1, it is a good time to revisit and improve the documentation to help developers adopt the new features quickly.

Related Issues

Closes #55837


^ 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 airflow-core/newsfragments.

@boring-cyborg
Copy link

boring-cyborg bot commented Sep 28, 2025

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 prek-hooks 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

Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. @pierrejeambrun @jscheffl @bbovenzi -> any comments?

@potiuk potiuk added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Oct 21, 2025
@potiuk potiuk added this to the Airflow 3.1.1 milestone Oct 21, 2025
@kaxil kaxil modified the milestones: Airflow 3.1.1, Airflow 3.1.2 Oct 21, 2025
@kaxil
Copy link
Member

kaxil commented Oct 21, 2025

Bump on reviews @pierrejeambrun @jscheffl @bbovenzi

Copy link
Contributor

@jscheffl jscheffl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides the one fix needed as indicated by Brent, good for me! LGTM after the small adjustment...

Co-authored-by: Brent Bovenzi <brent.bovenzi@gmail.com>
@jscheffl jscheffl requested a review from bbovenzi October 21, 2025 20:17
Copy link
Contributor

@jscheffl jscheffl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good for me (now - applied feedback from Brent)

@bbovenzi bbovenzi merged commit e6e3370 into apache:main Oct 21, 2025
60 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 21, 2025

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

github-actions bot pushed a commit that referenced this pull request Oct 21, 2025
…completeness (#56177)

* docs:improve plugin system documentation for clarity and completeness

* Apply suggestion from @kaxil

* Review feedback

Co-authored-by: Brent Bovenzi <brent.bovenzi@gmail.com>

---------
(cherry picked from commit e6e3370)

Co-authored-by: Lohith M <152604836+Lohith625@users.noreply.github.com>
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
Co-authored-by: Jens Scheffler <95105677+jscheffl@users.noreply.github.com>
Co-authored-by: Brent Bovenzi <brent.bovenzi@gmail.com>
@github-actions
Copy link

Backport successfully created: v3-1-test

Status Branch Result
v3-1-test PR Link

github-actions bot pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Oct 21, 2025
…completeness (apache#56177)

* docs:improve plugin system documentation for clarity and completeness

* Apply suggestion from @kaxil

* Review feedback

Co-authored-by: Brent Bovenzi <brent.bovenzi@gmail.com>

---------
(cherry picked from commit e6e3370)

Co-authored-by: Lohith M <152604836+Lohith625@users.noreply.github.com>
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
Co-authored-by: Jens Scheffler <95105677+jscheffl@users.noreply.github.com>
Co-authored-by: Brent Bovenzi <brent.bovenzi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:plugins backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(docs) Update Airflow Plugin Documentation

5 participants