[airflow] branch main updated: Update CONTRIBUTING.rst and CONTRIBUTORS_QUICK_START.rst files with jq installation instructions (#17060)

[po...@apache.org]

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

potiuk 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 9bc1353  Update CONTRIBUTING.rst and CONTRIBUTORS_QUICK_START.rst files with jq installation instructions (#17060)
9bc1353 is described below

commit 9bc1353967ee1a7cb55089d7f02b4ff01457cd3d
Author: Nijanthan Vijayakumar <60...@users.noreply.github.com>
AuthorDate: Sun Jul 18 00:34:03 2021 +1000

    Update CONTRIBUTING.rst and CONTRIBUTORS_QUICK_START.rst files with jq installation instructions (#17060)
    
    * Add jq installation info as a prerequisite for setting up breeze
    
    * Add macOS example for jq installation using Homebrew
    
    The "Configure Your Environment" section was missing the examples on
    installing jq on macOS. Earlier version of the document only had the
    example for the Ubuntu OS.
---
 CONTRIBUTING.rst             | 23 ++++++++++++++++++-----
 CONTRIBUTORS_QUICK_START.rst | 13 +++++++++++++
 2 files changed, 31 insertions(+), 5 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 95ab829..418baed 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -208,27 +208,40 @@ You can configure the Docker-based Breeze development environment as follows:
 1. Install the latest versions of the Docker Community Edition
    and Docker Compose and add them to the PATH.
 
-2. Enter Breeze: ``./breeze``
+2. Install jq on your machine. The exact command depends on the operating system (or Linux distribution) you use.
+For example, on Ubuntu:
+
+.. code-block:: bash
+
+  sudo apt install jq
+
+or on macOS with `Homebrew <https://formulae.brew.sh/formula/jq>`_
+
+.. code-block:: bash
+
+  brew install jq
+
+3. Enter Breeze: ``./breeze``
 
    Breeze starts with downloading the Airflow CI image from
    the Docker Hub and installing all required dependencies.
 
-3. Enter the Docker environment and mount your local sources
+4. Enter the Docker environment and mount your local sources
    to make them immediately visible in the environment.
 
-4. Create a local virtualenv, for example:
+5. Create a local virtualenv, for example:
 
 .. code-block:: bash
 
    mkvirtualenv myenv --python=python3.6
 
-5. Initialize the created environment:
+6. Initialize the created environment:
 
 .. code-block:: bash
 
    ./breeze initialize-local-virtualenv --python 3.6
 
-6. Open your IDE (for example, PyCharm) and select the virtualenv you created
+7. Open your IDE (for example, PyCharm) and select the virtualenv you created
    as the project's default virtualenv in your IDE.
 
 Step 3: Connect with People
diff --git a/CONTRIBUTORS_QUICK_START.rst b/CONTRIBUTORS_QUICK_START.rst
index 798d4ea..af91b9b 100644
--- a/CONTRIBUTORS_QUICK_START.rst
+++ b/CONTRIBUTORS_QUICK_START.rst
@@ -44,6 +44,7 @@ Prerequisites
 1. Docker Community Edition
 2. Docker Compose
 3. pyenv (you can also use pyenv-virtualenv or virtualenvwrapper)
+4. jq
 
 
 Installing Prerequisites on Ubuntu
@@ -176,6 +177,18 @@ Pyenv and setting up virtual-env
 
 
 
+Installing jq
+--------------------------------
+
+``jq`` is a lightweight and flexible command-line JSON processor.
+
+Install ``jq`` with the following command:
+
+.. code-block:: bash
+
+  $ sudo apt install jq
+
+
 
 Setup Airflow with Breeze and PyCharm
 #####################################