ZaneBartlett1 opened a new pull request, #30670:
URL: https://github.com/apache/airflow/pull/30670

   For context, I'm a pretty new developer, but I personally had a bit of a 
hard time parsing these instructions with them in one giant code block and 
instead thought they were actually some sort of configuration file. The four 
changes that I'm suggesting in this all relate to the instructions found in the 
code block, they are - 
   
   1. Breaking the code block up by step
   
   2. Including a note about setting the AIRFLOW_HOME variable before 
installation. This is pretty small but I think was part of what contributed to 
me being confused that this is not a config file as I'm not too used to setting 
environment variables for an application I haven't installed before.
   
   3. On step two, making a note/more explicit how the URL and constrain file 
ties together. That language of "Install Airflow using the constraints file", 
once I understood what was happening made total sense, but having the text be a 
bit more verbose would have saved me some time. My understanding at this time, 
which could be wrong (in which case I think that text still needs to be 
updated) is that our URL being passed will determine what constraint file to 
use.
   
   4. Making a note that the PYTHON_VERSION is being extracted as well as 
setting it manually if the user is running python 3.11 on their machine.
   
   <!--
   Thank you for contributing! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of an existing issue, reference it using one of the following:
   
   closes: #ISSUE
   related: #ISSUE
   
   How to write a good git commit message:
   http://chris.beams.io/posts/git-commit/
   -->
   
   ---
   **^ Add meaningful description above**
   
   Read the **[Pull Request 
Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)**
 for more information.
   In case of fundamental code changes, an Airflow Improvement Proposal 
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
 is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party 
License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in a 
newsfragment file, named `{pr_number}.significant.rst` or 
`{issue_number}.significant.rst`, in 
[newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
   


-- 
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]

Reply via email to