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.

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

Reorder and revise installation docs #9131

Merged
merged 1 commit into from
Nov 13, 2020

Conversation

uranusjr
Copy link
Member

Somewhat prompted by #9130, this attempts to make the installation instructions more natural to follow.

An additional section is added to instruct the user to self-check whether pip is installed before proceeding.

The Linux package manager section is moved to the front to encourage users to try that first before learning about get-pip.py, which tends to provide seemingly working but subtly broken results there. A paragraph
is added to the section to instruct users to report issues to package managers instead.

A new section on enturepip is added as an alternative to get-pip.py, which is almost guarenteed to be available at this point and should be preferred as a bootstrap method.

@uranusjr uranusjr added the type: docs Documentation related label Nov 13, 2020
@uranusjr uranusjr force-pushed the install-method-order branch 2 times, most recently from d1d0e78 to 3f21049 Compare November 13, 2020 20:09
@pradyunsg
Copy link
Member

(assuming the linters are happy with the changes)

An additional section is added to instruct the user to self-check
whether pip is installed before proceeding.

The Linux package manager section is moved to the front to encourage
users to try that first before learning about get-pip.py, which tends to
provide seemingly working but subtly broken results there. A paragraph
is added to the section to instruct users to report issues to package
managers instead.

A new section on enturepip is added as an alternative to get-pip.py,
which is almost guarenteed to be available at this point.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants