Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[AIRFLOW-XXXX] Fix development packages installtion instructions #6942

Merged
merged 1 commit into from
Dec 31, 2019
Merged

[AIRFLOW-XXXX] Fix development packages installtion instructions #6942

merged 1 commit into from
Dec 31, 2019

Conversation

xinbinhuang
Copy link
Contributor

@xinbinhuang xinbinhuang commented Dec 28, 2019 •
edited
Loading

Make sure you have checked all steps below.

Jira

  • My PR addresses the following Airflow Jira issues and references them in the PR title. For example, "[AIRFLOW-XXX] My Airflow PR"
    • https://issues.apache.org/jira/browse/AIRFLOW-XXX
    • In case you are fixing a typo in the documentation you can prepend your commit with [AIRFLOW-XXX], code changes always need a Jira issue.
    • In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal (AIP).
    • In case you are adding a dependency, check if the license complies with the ASF 3rd Party License Policy.

Description

Tests

  • My PR adds the following unit tests OR does not need testing for this extremely good reason:

Commits

  • My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain docstrings that explain what it does
    • If you implement backwards incompatible changes, please leave a note in the Updating.md so we can assign it to a appropriate release

@xinbinhuang
Copy link
Contributor Author

@potiuk I recreate the PR here. I combine the conda and virtualenvwrapper into the same section. Also, add a note on installing extras.

turbaszek
turbaszek requested changes Dec 28, 2019
View reviewed changes
LOCAL_VIRTUALENV.rst Outdated

``mkvirtualenv <ENV_NAME> --python=python<VERSION>``

b. Create a local virtualenv with conda
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This structure suggest that I should follow point a) then b) and that's not true.

Copy link
Contributor Author

@xinbinhuang xinbinhuang Dec 28, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be better if I change the ordered list into unordered list? My intention is to group the two ways of creating virtualenvs: using virtualenvwrapper etc vs conda into one big section as creating virtualenvs, as one equvilant to the other. So we don't need to repeat pip install and DB init separately in the doc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reorganize with a cleaner structure. Let me know how you think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nuclearpinguin A kindly reminder :). PTAL. Thanks!

LOCAL_VIRTUALENV.rst Show resolved Hide resolved
@xinbinhuang xinbinhuang force-pushed the update_doc branch 2 times, most recently from c77a302 to 85ac4b0 Compare December 29, 2019 00:05
potiuk
potiuk approved these changes Dec 29, 2019
View reviewed changes
Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small NIT only. Thanks for this @xinbinhuang !

LOCAL_VIRTUALENV.rst Show resolved Hide resolved
@potiuk
Copy link
Member

potiuk commented Dec 29, 2019

And Trailing whitespace to remove :)

@xinbinhuang
Copy link
Contributor Author

@potiuk Rebased and removed trailing space. Thanks!

@potiuk
Copy link
Member

potiuk commented Dec 30, 2019

LGTM. @nuclearpinguin - are you OK with this ?

@turbaszek turbaszek merged commit da2a617 into apache:master Dec 31, 2019
@xinbinhuang
Copy link
Contributor Author

Thanks for reviewing and merging @nuclearpinguin @potiuk

potiuk pushed a commit that referenced this pull request Jan 21, 2020
@xinbinhuang @potiuk
[AIRFLOW-XXX] Fix development packages installtion instructions (#6942)
ac91cd1 
(cherry picked from commit da2a617)
kaxil pushed a commit that referenced this pull request Jan 22, 2020
@xinbinhuang @kaxil
[AIRFLOW-XXX] Fix development packages installtion instructions (#6942)
6bbe1a4 
(cherry picked from commit da2a617)
kaxil pushed a commit that referenced this pull request Jan 23, 2020
@xinbinhuang @kaxil
[AIRFLOW-XXX] Fix development packages installtion instructions (#6942)
25221aa 
(cherry picked from commit da2a617)
potiuk pushed a commit that referenced this pull request Jan 26, 2020
@xinbinhuang @potiuk
[AIRFLOW-XXX] Fix development packages installtion instructions (#6942)
9411d61 
(cherry picked from commit da2a617)
kaxil pushed a commit that referenced this pull request Jan 26, 2020
@xinbinhuang @kaxil
[AIRFLOW-XXX] Fix development packages installtion instructions (#6942)
efc538d 
(cherry picked from commit da2a617)
galuszkak pushed a commit to FlyrInc/apache-airflow that referenced this pull request Mar 5, 2020
@xinbinhuang @galuszkak
[AIRFLOW-XXX] Fix development packages installtion instructions (apac…
c078832 
…he#6942)
kaxil pushed a commit to astronomer/airflow that referenced this pull request Mar 30, 2020
@xinbinhuang @kaxil
[AIRFLOW-XXX] Fix development packages installtion instructions (apac…
2f05600 
…he#6942)

(cherry picked from commit da2a617)
(cherry picked from commit efc538d)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@potiuk potiuk potiuk approved these changes

@turbaszek turbaszek turbaszek approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@xinbinhuang @potiuk @turbaszek