This is an automated email from the ASF dual-hosted git repository.
shahar1 pushed a commit to branch airflow-ctl/v0-1-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/airflow-ctl/v0-1-test by this
push:
new 60e078b39a2 [airflow-ctl/v0-1-test] Fix typos, grammar, and broken
references across the docs (#73146) (#76071)
60e078b39a2 is described below
commit 60e078b39a2d23f6deafed502fdbd402d637b4ad
Author: Shahar Epstein <[email protected]>
AuthorDate: Fri Oct 30 19:23:41 2026 +0200
[airflow-ctl/v0-1-test] Fix typos, grammar, and broken references across
the docs (#73146) (#76071)
* Fix typos, grammar, and broken references across the docs
Cleans up a batch of documentation issues found across airflow-core,
task-sdk, airflow-ctl, and chart docs: misspellings and grammar errors,
malformed RST directives and broken cross-references, stale/incorrect
code examples (a wrong module path, a missing import, an off-by-one in
a random.randint example), and a couple of factual inaccuracies (a
stale REST API version reference, an incorrect docker-compose service
name).
* Revert task-sdk API reference doc dedup
Leaving the autofunction/autoapifunction duplicate entries for task,
setup, and teardown as-is per request.
---------
Only the airflow-ctl/docs/ part is backported.
(cherry picked from commit e386b821844e736c026d162c9cde26e6b5325305)
Co-authored-by: Andrii Roiko <[email protected]>
---
airflow-ctl/docs/cli-and-env-variables-ref.rst | 2 +-
airflow-ctl/docs/howto/index.rst | 4 ++--
airflow-ctl/docs/installation/index.rst | 2 +-
airflow-ctl/docs/installation/installing-from-sources.rst | 14 +++++++-------
airflow-ctl/docs/installation/prerequisites.rst | 5 +----
5 files changed, 12 insertions(+), 15 deletions(-)
diff --git a/airflow-ctl/docs/cli-and-env-variables-ref.rst
b/airflow-ctl/docs/cli-and-env-variables-ref.rst
index 9ea878aaff5..4841a801188 100644
--- a/airflow-ctl/docs/cli-and-env-variables-ref.rst
+++ b/airflow-ctl/docs/cli-and-env-variables-ref.rst
@@ -47,7 +47,7 @@ Environment Variables
The token used to authenticate with the Airflow API. This is only
required if you are using the Airflow API and have not set up
- authentication using a different method. If username and password hasn't
been used.
+ authentication using a different method, such as a username and password.
.. envvar:: AIRFLOW_CLI_ENVIRONMENT
diff --git a/airflow-ctl/docs/howto/index.rst b/airflow-ctl/docs/howto/index.rst
index 91274e0c1e0..51e4ebc42a5 100644
--- a/airflow-ctl/docs/howto/index.rst
+++ b/airflow-ctl/docs/howto/index.rst
@@ -93,7 +93,7 @@ The token can be acquired from the Airflow API or generated
using a username and
Parameter Details for airflowctl auth login
```````````````````````````````````````````
-**--api-url**: This parameter is required. (e.g. ``http://localhost:8080``)
+**--api-url**: This parameter is optional. (e.g. ``http://localhost:8080``)
The default value is ``http://localhost:8080``. Full URL of the Airflow API.
Without any ``/api/*`` suffixes.
If you are running the ``airflowctl`` in ``breeze`` container, it is optional.
@@ -101,7 +101,7 @@ If you are running the ``airflowctl`` in ``breeze``
container, it is optional.
If you are setting the token via the environment variable
``AIRFLOW_CLI_TOKEN``, you can skip using this parameter.
**--username**: This parameter is optional.
-If you are not using ``--api-token`` or the environment variable
``AIRFLOW_CLI_TOKEN``, you must provide a username to authentication along with
``--password``.
+If you are not using ``--api-token`` or the environment variable
``AIRFLOW_CLI_TOKEN``, you must provide a username to authenticate along with
``--password``.
**--password**: This parameter is optional.
If you provide a username via ``--username`` this is the required password to
authenticate.
diff --git a/airflow-ctl/docs/installation/index.rst
b/airflow-ctl/docs/installation/index.rst
index d3f2062c297..97170bb00b7 100644
--- a/airflow-ctl/docs/installation/index.rst
+++ b/airflow-ctl/docs/installation/index.rst
@@ -30,7 +30,7 @@ Installation of airflowctl
Installing from sources <installing-from-sources>
Installing from PyPI <installing-from-pypi>
-This page describes installations options that you might use when considering
how to install Airflow®.
+This page describes installation options that you might use when considering
how to install Airflow®.
Airflow consists of many components, often distributed among many physical or
virtual machines, therefore
installation of Airflow might be quite complex, depending on the options you
choose.
diff --git a/airflow-ctl/docs/installation/installing-from-sources.rst
b/airflow-ctl/docs/installation/installing-from-sources.rst
index ebf02712350..43ba3e5e368 100644
--- a/airflow-ctl/docs/installation/installing-from-sources.rst
+++ b/airflow-ctl/docs/installation/installing-from-sources.rst
@@ -29,14 +29,14 @@ Released packages
the top-left of the page.
The Source packages are official packages of the Apache Software Foundation -
and the ones that you can
-use is you want to build the packages yourself from the source code and be
sure that the provenance of
+use if you want to build the packages yourself from the source code and be
sure that the provenance of
the packages is verified and matches the source code from the repository and
you can verify the
checksums and signatures of the packages.
-The ``sdist`` and ``whl`` packages released are the convenience packages - of
installation also installed from
+The ``sdist`` and ``whl`` packages released are the convenience packages - for
installation, also built from
the same sources and you can still verify the origin of the packages and want
to verify checksums and
-signatures of the packages. The packages are available via the Official Apache
Software Foundations Downloads
-`Official Apache Software Foundations Downloads <https://dlcdn.apache.org/>`_
+signatures of the packages. The packages are available via the
+`Official Apache Software Foundation Downloads <https://dlcdn.apache.org/>`_
The ``|version|`` downloads of Airflow Ctl are available at:
@@ -47,7 +47,7 @@ The ``|version|`` downloads of Airflow Ctl are available at:
* `Whl package for airflow-ctl distribution <{{ closer_lua_url
}}/apache_airflow_ctl-{{ airflowctl_version }}-py3-none-any.whl>`__ (`asc <{{
base_url }}/apache_airflow_ctl-{{ airflowctl_version
}}-py3-none-any.whl.asc>`__, `sha512 <{{ base_url }}/apache_airflow_ctl-{{
airflowctl_version }}-py3-none-any.whl.sha512>`__)
If you want to install from the source code, you can download from the sources
link above, it will contain
-a ``INSTALL`` file containing details on how you can build and install
airflowctl.
+an ``INSTALL`` file containing details on how you can build and install
airflowctl.
Release integrity
'''''''''''''''''
@@ -92,7 +92,7 @@ or
.. code-block:: bash
- pgp apache-airflow-********.asc
+ pgp apache-airflow-ctl-********.asc
Example:
@@ -118,7 +118,7 @@ For SHA512 sum check, download the relevant ``sha512`` and
run the following:
.. code-block:: bash
- shasum -a 512 apache-airflow-ctl--******** | diff -
apache-airflow-ctl--********.sha512
+ shasum -a 512 apache-airflow-ctl-******** | diff -
apache-airflow-ctl-********.sha512
The ``SHASUM`` of the file should match the one provided in ``.sha512`` file.
diff --git a/airflow-ctl/docs/installation/prerequisites.rst
b/airflow-ctl/docs/installation/prerequisites.rst
index 9d2efa3641c..4777b662476 100644
--- a/airflow-ctl/docs/installation/prerequisites.rst
+++ b/airflow-ctl/docs/installation/prerequisites.rst
@@ -18,10 +18,7 @@
Prerequisites
-------------
-airflowctl is tested with:
-
-
-The minimum memory required we recommend airflowctl to run with is 200MB, but
the actual requirements depend
+The minimum memory we recommend for airflowctl to run with is 200MB, but the
actual requirements depend
wildly on the deployment options you have.
The Keyring backend needs to be installed separately into your operating
system. This will enhance security. See :doc:`/security` for more information.
