Skip to content

Structure and small content improvements in installation.rst#13661

Merged
mik-laj merged 2 commits intoapache:masterfrom
PolideaInternal:instalation-structure
Jan 14, 2021
Merged

Structure and small content improvements in installation.rst#13661
mik-laj merged 2 commits intoapache:masterfrom
PolideaInternal:instalation-structure

Conversation

@mik-laj
Copy link
Member

@mik-laj mik-laj commented Jan 14, 2021

This page lacked a sectional breakdown and also some information was overly repetitive.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, 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 UPDATING.md.


**Prerequisites**

On Debian based Linux OS:
Copy link
Member Author

@mik-laj mik-laj Jan 14, 2021

Choose a reason for hiding this comment

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

This information looks out of date. We have a section on system requirements below where there are some more libraries. See: Requirements (old docs), System dependencies (old docs)

does not yet work with Apache Airflow and might lead to errors in installation - depends on your choice
of extras. In order to install Airflow you need to either downgrade pip to version 20.2.4
``pip install --upgrade pip==20.2.4`` or, in case you use Pip 20.3, you need to add option
``--use-deprecated legacy-resolver`` to your pip install command.
Copy link
Member Author

Choose a reason for hiding this comment

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

This text was repeated several times. I understand the purpose of this, but now we have a new "Installation tools" section so this seems redundant.


You also need database client packages (Postgres or MySQL) if you want to use those databases.

If the ``airflow`` command is not getting recognized (can happen on Windows when using WSL), then
Copy link
Member Author

Choose a reason for hiding this comment

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

I moved that to the "troubleshooting" section because it didn't fit me here.

@mik-laj mik-laj requested review from kaxil and potiuk January 14, 2021 02:57
@mik-laj mik-laj changed the title Structure and small improvements in installation.rst Structure and small content improvements in installation.rst Jan 14, 2021
@github-actions
Copy link

The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest master or amend the last commit of the PR, and push it with --force-with-lease.

@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Jan 14, 2021
@mik-laj mik-laj merged commit 39f0365 into apache:master Jan 14, 2021
@mik-laj mik-laj deleted the instalation-structure branch January 14, 2021 09:26
kaxil pushed a commit that referenced this pull request Jan 21, 2021
* Structure improvments in installation.rst file

* fixup! Structure improvments in installation.rst file

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

Labels

kind:documentation okay to merge It's ok to merge this PR as it does not require more tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants