Skip to content

Add providers, operators, and hooks readmes#11829

Merged
ryw merged 3 commits intoapache:masterfrom
petedejoy:provider-readme
Oct 27, 2020
Merged

Add providers, operators, and hooks readmes#11829
ryw merged 3 commits intoapache:masterfrom
petedejoy:provider-readme

Conversation

@petedejoy
Copy link
Contributor

@petedejoy petedejoy commented Oct 24, 2020

It took me quite a while to piece together how exactly operators, hooks, and providers would be released and distributed in Airflow 2.0 and beyond from various mailing list threads, AIPs, and slack conversations. Hoping that adding a little bit of color to readmes in the relevant subdirectories will help users who may be less familiar with the maintenance of the project figure out how exactly the operators, hooks, and providers directories differ. Someone should give these a quick once-over to validate that my mental model is accurate.


Read the Pull Request Guidelines for more information.
In case of fundamental code change, 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 UPDATING.md.

@petedejoy petedejoy requested a review from kaxil October 24, 2020 16:49
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.

NICE!

@potiuk
Copy link
Member

potiuk commented Oct 24, 2020

Just one EOF static check failiing :)

@petedejoy
Copy link
Contributor Author

Thanks @potiuk! Is that failing because I need to add a new line at the end of these files?

@github-actions
Copy link

The Workflow run is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks$,^Build docs$,^Spell check docs$,^Backport packages$,^Checks: Helm tests$,^Test OpenAPI*.

@github-actions
Copy link

The Workflow run is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks$,^Build docs$,^Spell check docs$,^Backport packages$,^Checks: Helm tests$,^Test OpenAPI*.


# Airflow Operators

Airflow operators are modules that represent a single, ideally idempotent task. They are arbiters of the logic that executes when your DAG runs.
Copy link
Member

Choose a reason for hiding this comment

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

I'd capitalize "Airflow Operators"

@ryw ryw merged commit 2cf1611 into apache:master Oct 27, 2020
michalmisiewicz pushed a commit to michalmisiewicz/airflow that referenced this pull request Oct 30, 2020
* Add readmes with relevant information for Airflow 2.0 to providers, operators, and hooks directories

* Add newline to end of files

* Remove hanging EOF empty line
szn pushed a commit to szn/airflow that referenced this pull request Nov 1, 2020
* Add readmes with relevant information for Airflow 2.0 to providers, operators, and hooks directories

* Add newline to end of files

* Remove hanging EOF empty line
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants