[GitHub] [airflow] potiuk commented on a change in pull request #17060: Update CONTRIBUTING.rst and CONTRIBUTORS_QUICK_START.rst files with jq installation instructions

[GitBox <gi...@apache.org>]

potiuk commented on a change in pull request #17060:
URL: https://github.com/apache/airflow/pull/17060#discussion_r671694528



##########
File path: CONTRIBUTING.rst
##########
@@ -208,27 +208,33 @@ 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, using the following command:
+
+.. code-block:: bash
+
+  sudo apt install jq

Review comment:
       For quick-start yeah. But the `CONTRIBUTING.rst` change is more "generic". I think this CONTRIBUTING is for people who know what they are doing, know what system they have, and they can follow if ubuntu - this if os - that. So what @uranusjr proposes is good. Those examples here is more what we say "examples" - and for people who are experts, they might want to have other ways of installing those deps.
   
   The `Quick-start` is more for people who wanted to quickly go through the steps, sometimes without full knowledge of what they are doing (but willing to learn it) and there it is better to have two chapters "prerequisites for Ubuntu" and "prerequisites for Mac" with more detailed and accurate instructions and troubleshooting. These should be much more "robust" and guide the user step-by-step.
   
   We miss the 'MacOS' part there - another PR to do :)




-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org