Skip to content

build(pre-commit): add list of supported deferrable operators to doc - #32514

Merged
eladkal merged 2 commits into
apache:mainfrom
astronomer:add-deferrable-list-to-doc
Jul 20, 2023
Merged

build(pre-commit): add list of supported deferrable operators to doc#32514
eladkal merged 2 commits into
apache:mainfrom
astronomer:add-deferrable-list-to-doc

Conversation

@Lee-W

@Lee-WLee-W commented Jul 11, 2023•
edited
Loading

Copy link
Copy Markdown
Member

Add "Supported Deferrable Operator" page in apache-airflow-providers core extension section

example page

圖片

related: #31712 (comment)

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

uranusjr
uranusjr reviewed Jul 11, 2023
View reviewed changes
Comment threadSTATIC_CODE_CHECKS.rst Outdated
eladkal
eladkal requested changes Jul 11, 2023
View reviewed changes
Comment threaddocs/apache-airflow/deferrable-operator-ref.rst Outdated
@Lee-W
Lee-Wforce-pushed the add-deferrable-list-to-doc branch 5 times, most recently from a8e30c5 to 69a7720CompareJuly 11, 2023 09:25
potiuk
potiuk reviewed Jul 11, 2023
View reviewed changes

@potiukpotiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think that list should be added to "docs/apache-airflow-providers/core-extensions" not "docs/apache-airflow" and linked from there. Then at most we should link to it from the "apache-airflow" documentation. This way we do not tie particular version of Airflow to providers - only to a general "providers" docs and they can be updated independently.

That's the purpise of "docs/apache-airflow-providers" (available at https://airflow.apache.org/docs/apache-airflow-providers/index.html)

@potiuk

potiuk commented Jul 11, 2023

Copy link
Copy Markdown
Member

See also a few other places (like connections, secrets etc. where there are links from "apache-airflow" to "apache-airflow-providers" documentation.

@Lee-W
Lee-Wforce-pushed the add-deferrable-list-to-doc branch 4 times, most recently from c72776d to 882e6d7CompareJuly 11, 2023 15:08
@Lee-W

Lee-W commented Jul 11, 2023

Copy link
Copy Markdown
MemberAuthor

Hi @eladkal@potiuk@uranusjr , thanks for your suggestions! I've made change accordingly

@Lee-W
Lee-W marked this pull request as ready for review July 11, 2023 15:13
@Lee-W
Lee-Wforce-pushed the add-deferrable-list-to-doc branch from 882e6d7 to d9f2575CompareJuly 11, 2023 15:36
@potiuk
potiuk requested a review from eladkalJuly 12, 2023 14:33
@potiuk

potiuk commented Jul 12, 2023

Copy link
Copy Markdown
Member

nice one :)

@Lee-W
Lee-Wforce-pushed the add-deferrable-list-to-doc branch from d9f2575 to 20478d4CompareJuly 13, 2023 07:46
@potiuk

potiuk commented Jul 13, 2023

Copy link
Copy Markdown
Member

@eladkal ?

@Lee-W
Lee-Wforce-pushed the add-deferrable-list-to-doc branch from 20478d4 to 1a9485dCompareJuly 20, 2023 00:41
@Lee-W
Lee-Wforce-pushed the add-deferrable-list-to-doc branch from 1a9485d to f83683cCompareJuly 20, 2023 01:55
@potiuk

potiuk commented Jul 20, 2023

Copy link
Copy Markdown
Member

@eladkal ?

@eladkal
eladkal merged commit dff360e into apache:mainJul 20, 2023
pateash pushed a commit to pateash/airflow that referenced this pull request Jul 23, 2023
@Lee-W@pateash
build(pre-commit): add list of supported deferrable operators to doc (a…
28997b7
…pache#32514)
* build(pre-commit): add list of supported deferrable operators to doc
* docs(providers): move providers list to apache-airflow-providers core-extension
@ephraimbuddyephraimbuddy added the changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) label Aug 2, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@uranusjruranusjruranusjr left review comments
@potiukpotiukpotiuk approved these changes
@eladkaleladkaleladkal approved these changes
@phanikumvphanikumvphanikumv approved these changes

Assignees

No one assigned

Labels

area:dev-toolschangelog:skipChanges that should be skipped from the changelog (CI, tests, etc..)kind:documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Lee-W@potiuk@uranusjr@eladkal@phanikumv@ephraimbuddy