uranusjr commented on a change in pull request #19124: URL: https://github.com/apache/airflow/pull/19124#discussion_r733319411
########## File path: CONTRIBUTING.rst ########## @@ -221,10 +221,14 @@ or on macOS with `Homebrew <https://formulae.brew.sh/formula/jq>`_ brew install jq -3. Enter Breeze: ``./breeze`` +3. Enter Breeze, in airflow folder run: - Breeze starts with downloading the Airflow CI image from - the Docker Hub and installing all required dependencies. +.. code-block:: bash + + ./breeze + +Breeze starts with downloading the Airflow CI image from +the Docker Hub and installing all required dependencies. Review comment: You need to match indentation here for restructuredText to render correctly. ########## File path: CONTRIBUTING.rst ########## @@ -221,10 +221,14 @@ or on macOS with `Homebrew <https://formulae.brew.sh/formula/jq>`_ brew install jq -3. Enter Breeze: ``./breeze`` +3. Enter Breeze, in airflow folder run: Review comment: Unintuitively, "airflow folder" actually produces more ambigiouty because there are two such directories, one for the Airflow *source code* and one for the *configuration files* (at `/root/airflow`). ```suggestion 3. Enter Breeze, and run the following in the Airflow source code directory: ``` ########## File path: CONTRIBUTING.rst ########## @@ -221,10 +221,14 @@ or on macOS with `Homebrew <https://formulae.brew.sh/formula/jq>`_ brew install jq -3. Enter Breeze: ``./breeze`` +3. Enter Breeze, in airflow folder run: - Breeze starts with downloading the Airflow CI image from - the Docker Hub and installing all required dependencies. +.. code-block:: bash + + ./breeze Review comment: ```suggestion .. code-block:: bash ./breeze ``` ########## File path: CONTRIBUTING.rst ########## @@ -205,10 +205,10 @@ The Docker env is here to maintain a consistent and common development environme 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. +1. Install the latest versions of the `Docker Community Edition <https://github.com/apache/airflow/blob/main/BREEZE.rst#docker-community-edition>`_ +and `Docker Compose <https://github.com/apache/airflow/blob/main/BREEZE.rst#docker-compose>`_ and add them to the PATH. -2. Install jq on your machine. The exact command depends on the operating system (or Linux distribution) you use. +2. Install `jq <https://stedolan.github.io/jq/download/>`_ on your machine. The exact command depends on the operating system (or Linux distribution) you use. Review comment: Indentation also needs to be fixed here. Also, consider moving the references out-of-line (external) instead of embedding. https://docutils.sourceforge.io/docs/user/rst/quickref.html#external-hyperlink-targets -- 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]
