Improve Quick Start instructions #30820
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
potiuk
approved these changes
Apr 23, 2023
|
Nice! |
|
Assuming tests pass, that would be yet ANOTHER doc-only candidate for 2.6.0 assuming we are not releasing now @ephraimbuddy @pierrejeambrun |
potiuk
reviewed
Apr 23, 2023
potiuk
reviewed
Apr 23, 2023
potiuk
reviewed
Apr 23, 2023
|
Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions. |
|
Thanks @ZaneBartlett1 ! |
|
Happy to help! |
ephraimbuddy
pushed a commit
that referenced
this pull request
May 8, 2023
Co-authored-by: Jarek Potiuk <[email protected]> (cherry picked from commit f5f35b3)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For context, I'm a pretty new developer, but I personally had a bit of a hard time parsing the Quick Start 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 -
Breaking the code block up by step
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.
On step two, making a note/more explicit how the URL and constraint 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.
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.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.