Skip to content

Conversation

@potiuk
Copy link
Member

@potiuk potiuk commented Aug 5, 2023

The #33081 added documentation generation for CLI commands contributed by executors coming from providers. Adding Airflow documentation in the same PR was not really possible because it created a documentation reference circle and we had to wait until the documentation inventory has been released in S3 and since this already happened, we can now add links to provider CLIs from Airflow.


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

The apache#33081 added documentation generation for CLI commands contributed
by executors coming from providers. Adding Airflow documentation in
the same PR was not really possible because it created a documentation
reference circle and we had to wait until the documentation inventory
has been released in S3 and since this already happened, we can now
add links to provider CLIs from Airflow.
@potiuk
Copy link
Member Author

potiuk commented Aug 5, 2023

Looks like that:

Screenshot 2023-08-05 at 19 21 04

@potiuk potiuk added this to the Airflow 2.7.0 milestone Aug 5, 2023
@potiuk potiuk requested a review from ephraimbuddy August 5, 2023 17:28
@potiuk potiuk merged commit 9910d92 into apache:main Aug 5, 2023
@potiuk potiuk deleted the add-links-to-celery-kubernetes-cli-commands branch August 5, 2023 19:55
ephraimbuddy pushed a commit that referenced this pull request Aug 8, 2023
…33143)

The #33081 added documentation generation for CLI commands contributed
by executors coming from providers. Adding Airflow documentation in
the same PR was not really possible because it created a documentation
reference circle and we had to wait until the documentation inventory
has been released in S3 and since this already happened, we can now
add links to provider CLIs from Airflow.

(cherry picked from commit 9910d92)
:depth: 2

Providers that implement executors might contribute additional commands to the CLI. Here are the commands
contributed by the community providers:
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be worth it to add a Note that says something like "NOTE: only commands for the currently configured executor will be exposed on the CLI"

Just so that behaviour is documented, WDYT? @potiuk

I can open a PR for that as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes.

@ephraimbuddy ephraimbuddy added type:improvement Changelog: Improvements AIP-51 AIP-51: Remove executor coupling from Core changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) and removed type:improvement Changelog: Improvements labels Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AIP-51 AIP-51: Remove executor coupling from Core area:CLI changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) kind:documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants