Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Establishing short hand argument for apache-airflow-providers rule #34230

Merged
merged 3 commits into from
Sep 9, 2023

Conversation

amoghrajesh
Copy link
Contributor

@amoghrajesh amoghrajesh commented Sep 9, 2023

Adding ability to use short hand for apache-airflow-providers rule also. You can now use a providers-index for that rule without the package filter.

Example:

breeze build-docs providers-index cncf.kubernetes sftp

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

@amoghrajesh
Copy link
Contributor Author

@potiuk @eladkal a small improvement on the short hand rules. Can you take a look when you have some time?

BREEZE.rst Outdated
@@ -492,6 +492,8 @@ Now with the remaining part, replace every ``dash("-")`` with a ``dot(".")``.
Example:
If the provider name is ``apache-airflow-providers-cncf-kubernetes``, it will be ``cncf.kubernetes``.

Note: For building docs for apache-airflow-providers index, use dot``(.)`` as short hand operator.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe providers is a better choice?

Copy link
Member

Choose a reason for hiding this comment

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

Or providers-index ? (Since we have all-providers already.

Copy link
Member

Choose a reason for hiding this comment

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

I don't think the dot is the best choice. providers-index looks better.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure sure, makes sense

@potiuk potiuk merged commit 927e8b7 into apache:main Sep 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants