You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by ja...@apache.org on 2026/03/09 04:43:02 UTC

(airflow) branch main updated: Fix typos and improve clarity in CI documentation (#63163)

This is an automated email from the ASF dual-hosted git repository.

jasonliu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/main by this push:
     new 11d345ca677 Fix typos and improve clarity in CI documentation (#63163)
11d345ca677 is described below

commit 11d345ca677df33e12a1ba1ff806e071c496623a
Author: Aaron Chen <na...@gmail.com>
AuthorDate: Sun Mar 8 21:42:54 2026 -0700

    Fix typos and improve clarity in CI documentation (#63163)
---
 dev/breeze/doc/ci/01_ci_environment.md   | 2 +-
 dev/breeze/doc/ci/02_images.md           | 4 ++--
 dev/breeze/doc/ci/04_selective_checks.md | 4 ++--
 dev/breeze/doc/ci/README.md              | 4 ++--
 4 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/dev/breeze/doc/ci/01_ci_environment.md b/dev/breeze/doc/ci/01_ci_environment.md
index d434cf84d05..c785018dbd5 100644
--- a/dev/breeze/doc/ci/01_ci_environment.md
+++ b/dev/breeze/doc/ci/01_ci_environment.md
@@ -36,7 +36,7 @@ robust and stable. We run a lot of tests for every pull request,
 for `canary` runs from `main` and `v*-\*-test` branches
 regularly as scheduled jobs.
 
-Our execution environment for CI is [GitHub Actions](https://github.com/features/actions). GitHub Actions.
+Our execution environment for CI is [GitHub Actions](https://github.com/features/actions).
 
 However. part of the philosophy we have is that we are not tightly
 coupled with any of the CI environments we use. Most of our CI jobs are
diff --git a/dev/breeze/doc/ci/02_images.md b/dev/breeze/doc/ci/02_images.md
index ac9772f4a0f..ea2eb67a4bc 100644
--- a/dev/breeze/doc/ci/02_images.md
+++ b/dev/breeze/doc/ci/02_images.md
@@ -342,7 +342,7 @@ faster. It is enough to download and uncompress the artifact that stores the
 image and run ``breeze ci-image load -i <path-to-image.tar>`` to load the
 image and mark the image as refreshed in the local cache.
 
-You can see more details and examples in[Breeze](../06_managing_docker_images.rst)
+You can see more details and examples in [Breeze](../06_managing_docker_images.rst).
 
 # Customizing the CI image
 
@@ -350,7 +350,7 @@ Customizing the CI image allows to add your own dependencies to the
 image.
 
 The easiest way to build the customized image is to use `breeze` script,
-but you can also build suc customized image by running appropriately
+but you can also build such customized image by running appropriately
 crafted docker build in which you specify all the `build-args` that you
 need to add to customize it. You can read about all the args and ways
 you can build the image in the
diff --git a/dev/breeze/doc/ci/04_selective_checks.md b/dev/breeze/doc/ci/04_selective_checks.md
index daeba8b4b17..ab20ef96add 100644
--- a/dev/breeze/doc/ci/04_selective_checks.md
+++ b/dev/breeze/doc/ci/04_selective_checks.md
@@ -160,7 +160,7 @@ providers.
 
 The selective check outputs available are described below. In case of `list-as-string` values,
 empty string means `everything`, where lack of the output means `nothing` and list elements are
-separated by spaces. This is to accommodate for the wau how outputs of this kind can be easily used by
+separated by spaces. This is to accommodate for the way how outputs of this kind can be easily used by
 GitHub Actions to pass the list of parameters to a command to execute
 
 
@@ -185,7 +185,7 @@ GitHub Actions to pass the list of parameters to a command to execute
 | docker-cache                                            | Which cache should be used for images ("registry", "local" , "disabled")                                | registry                                 |      |
 | docs-build                                              | Whether to build documentation ("true"/"false")                                                         | true                                     |      |
 | docs-list-as-string                                     | What filter to apply to docs building - based on which documentation packages should be built           | apache-airflow helm-chart google         | *    |
-| excluded-providers-as-string   c                        | List of providers that should be excluded from the build as space-separated string                      | amazon google                            | *    |
+| excluded-providers-as-string                            | List of providers that should be excluded from the build as space-separated string                      | amazon google                            | *    |
 | force-pip                                               | Whether pip should be forced in the image build instead of uv ("true"/"false")                          | false                                    |      |
 | full-tests-needed                                       | Whether this build runs complete set of tests or only subset (for faster PR builds) \[1\]               | false                                    |      |
 | generated-dependencies-changed                          | Whether generated dependencies have changed ("true"/"false")                                            | false                                    |      |
diff --git a/dev/breeze/doc/ci/README.md b/dev/breeze/doc/ci/README.md
index c5153e0757a..ad4fec8d823 100644
--- a/dev/breeze/doc/ci/README.md
+++ b/dev/breeze/doc/ci/README.md
@@ -24,9 +24,9 @@
 This directory contains detailed design of the Airflow CI setup.
 
 * [CI Environment](01_ci_environment.md) - contains description of the CI environment
-* [Image Naming](02_images.md) - contains description of the naming conventions for the images
+* [Images](02_images.md) - contains description of the CI and PROD images, how to build and customize them, and naming conventions
 * [GitHub Variables](03_github_variables.md) - contains description of the GitHub variables used in CI
-* [Selective checks](04_selective_checks.md) - contains description of the selective checks performed in CI
+* [Selective Checks](04_selective_checks.md) - contains description of the selective checks performed in CI
 * [Workflows](05_workflows.md) - contains description of the workflows used in CI
 * [Debugging](06_debugging.md) - contains description of debugging CI issues
 * [Running CI Locally](07_running_ci_locally.md) - contains description of running CI locally