Skip to content

Conversation

@shubhdevelops
Copy link

Draft PR to start work on allowing custom providers to define their own documentation URLs.

Related issue: #59576

This PR currently only adds a TODO marker in the UI code to highlight where
provider-specific documentation URLs should be handled.

No functional changes yet. This draft is meant for coordination and early feedback.


^ 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.

Add TODO comment for provider documentation URL handling
@boring-cyborg boring-cyborg bot added the area:UI Related to UI/UX. For Frontend Developers. label Dec 20, 2025
@boring-cyborg
Copy link

boring-cyborg bot commented Dec 20, 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

@shubhdevelops
Copy link
Author

I’ve opened a draft PR to start working on this and to coordinate on the approach.
Happy to adjust based on feedback.

@shubhdevelops shubhdevelops marked this pull request as draft December 20, 2025 22:40
Allow Providers UI to link to custom provider documentation URLs
when provided, with fallback to default Airflow docs.
@jroachgolf84
Copy link
Collaborator

@shubhdevelops, there are a few things missing in this PR. As a learning experience, check out my PR (#59584) to see the additional changes that were needed for this.

Copy link
Member

@jason810496 jason810496 left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution!

there are a few things missing in this PR. As a learning experience, check out my PR (#59584) to see the additional changes that were needed for this.

Yes, we still need to change the ProviderManager and backend API as well, so sorry that we might need to close this PR.

@jason810496
Copy link
Member

Sorry again for closing this PR, as #59584 already implemented the same feature. I appreciate your contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:UI Related to UI/UX. For Frontend Developers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants