Refactor installation pages #18282
Merged
Refactor installation pages #18282
Conversation
This file contains hidden or 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
requested review from
jedcunningham,
kaxil,
mik-laj and
vikramkoka
as code owners
boring-cyborg
bot
added
area:helm-chart
Member
Author
|
|
potiuk
force-pushed
the
installation-documentation-refactor
branch
from
5938a64 to
ebda2e2
Compare
Member
Author
|
I noticed and fixed duplication in the TOC (comparing to earlier screenshots) - the new left-hand menu looks much better now and we have consistent "Using" when we talk about installation methods.
|
mik-laj
reviewed
Sep 16, 2021
mik-laj
reviewed
Sep 16, 2021
mik-laj
reviewed
Sep 16, 2021
mik-laj
reviewed
Sep 16, 2021
mik-laj
reviewed
Sep 16, 2021
potiuk
force-pushed
the
installation-documentation-refactor
branch
from
ebda2e2 to
fad98b0
Compare
Member
Author
|
Addressed @mik-laj 's comments, also added some more cleanups and converted the descriptions of various options into bullet points (looks easier to compare and better organized this way):
|
potiuk
force-pushed
the
installation-documentation-refactor
branch
from
fad98b0 to
3d53633
Compare
Member
Author
|
Anyone :) ? I really think it's going to help new users. |
kaxil
reviewed
Sep 16, 2021
potiuk
force-pushed
the
installation-documentation-refactor
branch
from
2c500cd to
be00c4f
Compare
potiuk
force-pushed
the
installation-documentation-refactor
branch
from
be00c4f to
9f4a50f
Compare
This PR splits ad improves the installation-related documentation for Airflow. The "installation" page had become overloaded wiht everything-but-the-kitchen-sink and it became rather difficult to navigate and link to relevant sections. Also there was not a single page where one could have an overview on different installation methods possible, cases when each instalation works best as well as understanding what is involved in following each installation method in terms of maintenance, and expectations that users should have when it comes to what Apache Airflow Community provides. The PR leaves the installation page as basically a summary of all installation methods with all above explained and links to detailed pages explaining prerequisites, dependencies, database setup and supported versions.
potiuk
force-pushed
the
installation-documentation-refactor
branch
from
9f4a50f to
4d9a8ec
Compare
mik-laj
reviewed
Sep 16, 2021
mik-laj
reviewed
Sep 16, 2021
mik-laj
reviewed
Sep 16, 2021
mik-laj
approved these changes
Sep 17, 2021
github-actions
bot
added
the
okay to merge
|
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 main or amend the last commit of the PR, and push it with --force-with-lease. |
2 tasks
potiuk
added a commit
that referenced
this pull request
Sep 17, 2021
This PR splits ad improves the installation-related documentation for Airflow. The "installation" page had become overloaded wiht everything-but-the-kitchen-sink and it became rather difficult to navigate and link to relevant sections. Also there was not a single page where one could have an overview on different installation methods possible, cases when each instalation works best as well as understanding what is involved in following each installation method in terms of maintenance, and expectations that users should have when it comes to what Apache Airflow Community provides. The PR leaves the installation page as basically a summary of all installation methods with all above explained and links to detailed pages explaining prerequisites, dependencies, database setup and supported versions. (cherry picked from commit 4308a8c)
Member
|
🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR splits ad improves the installation-related documentation
for Airflow. The "installation" page had become overloaded
wiht everything-but-the-kitchen-sink and it became rather
difficult to navigate and link to relevant sections.
Also there was not a single page where one could have an overview
on different installation methods possible, cases when
each instalation works best as well as understanding what
is involved in following each installation method in terms of
maintenance, and expectations that users should have when it
comes to what Apache Airflow Community provides.
The PR leaves the installation page as basically a summary of
all installation methods with all above explained and links
to detailed pages explaining prerequisites, dependencies,
database setup and supported versions.
^ 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.