potiuk commented on code in PR #34004:
URL: https://github.com/apache/airflow/pull/34004#discussion_r1315167232
##########
BREEZE.rst:
##########
@@ -478,6 +481,16 @@ These are all available flags of ``build-docs`` command:
:width: 100%
:alt: Breeze build documentation
+.. _generating_short_form_names:
+
+Generating short form names for Providers
+-----------------------------------------
+
+Skip the ``apache-airflow-providers-`` from the usual provider full names.
+Now with the remaining part, replace every ``dash("-")`` with a ``dot(".")``.
Review Comment:
It's just explanation for parmeter names in Breeze. Historicallly we use
"apache-airflow-providers-cncf-kubernetes` and `--package-filter` to choose
which packages to build. But we already use "short version" of those packages
when we run some breeze command and this change is purely UX change so that you
can specify them easier when you run command line. Instead of:
```
breeze build-docs --package-filter apache-airflow-providers-cncf-kubernetes
--package-filter apache-airflow-providers-google --package-filter apache-airflow
```
you wil be able to specify:
```
breeze build-docs cncf.kubernetes google apache-airflow
```
This explanation is there to explain the user how to derive the short id
from the long one used so far.
It's part of `build-docs` command description,
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]