This is an automated email from the ASF dual-hosted git repository. ephraimanierobi pushed a commit to branch v2-6-test in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 60cbc733436d58640d23a8763f3c32dc6fe7113f Author: minseok <[email protected]> AuthorDate: Sun May 7 16:09:43 2023 +0900 Fix typos in dev documentation (#31115) (cherry picked from commit 4937a18b8494dfa8977e18889324222808bb27ab) --- CONTRIBUTORS_QUICK_START.rst | 8 ++++---- STATIC_CODE_CHECKS.rst | 4 ++-- airflow/api_connexion/openapi/v1.yaml | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTORS_QUICK_START.rst b/CONTRIBUTORS_QUICK_START.rst index 089216cae8..c1ffe4d4fc 100644 --- a/CONTRIBUTORS_QUICK_START.rst +++ b/CONTRIBUTORS_QUICK_START.rst @@ -35,11 +35,11 @@ There are three ways you can run the Airflow dev env: 2. With a local virtual environment (on your local machine). 3. With a remote, managed environment (via remote development environment) -Before deciding which method to choose, there are a couple factors to consider: +Before deciding which method to choose, there are a couple of factors to consider: * Running Airflow in a container is the most reliable way: it provides a more consistent environment and allows integration tests with a number of integrations (cassandra, mongo, mysql, etc.). - However it also requires **4GB RAM, 40GB disk space and at least 2 cores**. + However, it also requires **4GB RAM, 40GB disk space and at least 2 cores**. * If you are working on a basic feature, installing Airflow on a local environment might be sufficient. For a comprehensive venv tutorial - visit `Virtual Env guide <https://github.com/apache/airflow/blob/main/LOCAL_VIRTUALENV.rst>`_ @@ -48,13 +48,13 @@ Before deciding which method to choose, there are a couple factors to consider: Local machine development ######################### -If you do not work with remote development environment, you need those prerequisites. +If you do not work in remote development environment, you need those prerequisites. 1. Docker Community Edition (you can also use Colima, see instructions below) 2. Docker Compose 3. pyenv (you can also use pyenv-virtualenv or virtualenvwrapper) -The below setup describe `Ubuntu installation <https://docs.docker.com/engine/install/ubuntu/>`_. It might be slightly different on different machines. +The below setup describes `Ubuntu installation <https://docs.docker.com/engine/install/ubuntu/>`_. It might be slightly different on different machines. Docker Community Edition ------------------------ diff --git a/STATIC_CODE_CHECKS.rst b/STATIC_CODE_CHECKS.rst index 2daab5128a..8541fe5ec1 100644 --- a/STATIC_CODE_CHECKS.rst +++ b/STATIC_CODE_CHECKS.rst @@ -112,13 +112,13 @@ Available pre-commit checks ........................... This table lists pre-commit hooks used by Airflow. The ``Image`` column indicates which hooks -require Breeze Docker image to be build locally. +require Breeze Docker image to be built locally. .. note:: Disabling particular checks In case you have a problem with running particular ``pre-commit`` check you can still continue using the benefits of having ``pre-commit`` installed, with some of the checks disabled. In order to disable - checks you might need to set ``SKIP`` environment variable to coma-separated list of checks to skip. For example + checks you might need to set ``SKIP`` environment variable to coma-separated list of checks to skip. For example, when you want to skip some checks (ruff/mypy for example), you should be able to do it by setting ``export SKIP=ruff,mypy-core,``. You can also add this to your ``.bashrc`` or ``.zshrc`` if you do not want to set it manually every time you enter the terminal. diff --git a/airflow/api_connexion/openapi/v1.yaml b/airflow/api_connexion/openapi/v1.yaml index 26e8a222ab..0b74001ed6 100644 --- a/airflow/api_connexion/openapi/v1.yaml +++ b/airflow/api_connexion/openapi/v1.yaml @@ -86,7 +86,7 @@ info: ### Delete - Deleting a resource requires the resource `id` and is typically executing via an HTTP `DELETE` request. + Deleting a resource requires the resource `id` and is typically executed via an HTTP `DELETE` request. The response usually returns a `204 No Content` response code upon success. ## Conventions @@ -150,7 +150,7 @@ info: Using a graphical tool such as [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/), it is possible to import the API specifications directly: - 1. Download the API specification by clicking the **Download** button at top of this document + 1. Download the API specification by clicking the **Download** button at the top of this document 2. Import the JSON specification in the graphical tool of your choice. - In *Postman*, you can click the **import** button at the top - With *Insomnia*, you can just drag-and-drop the file on the UI
