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

[Docs] Update linux install docs, redo venv docs #2920

Merged
merged 7 commits into from Aug 30, 2019

Conversation

@Tobotimus
Copy link
Member

commented Aug 6, 2019

Some of our pre-req installation docs needed updating on Linux - this adds new sections for Fedora Linux and Debian/Raspbian Buster, and also removes some unnecessary pre-requirements from other distributions. These have all been tested on fresh VPSes, installing Red both in venvs and with --user, and they all seem to work.

Also, apparently the venv docs were too scary before. These changes try to make it clear that it's easier to use than users may think.

This also includes a little note to stop users from accidentally installing Python with pyenv after installing pre-requirements on Ubuntu.

Resolves #2558.

Some of our pre-req installation docs needed updating on Windows - this adds new sections for Fedora Linux and Debian/Raspbian Buster, and also removes some unnecessary pre-requirements from other distributions. These have all been tested on fresh VPSes, installing Red both in venvs and with --user, and they all seem to work.

Also, apparently the venv docs were too scary before. These changes try to make it clear that it's easier to use than users may think.

This also includes a little note to stop users from accidentally installing Python with pyenv after installing pre-requirements on Ubuntu.

Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
@Tobotimus Tobotimus requested review from palmtree5 and tekulvw as code owners Aug 6, 2019
Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
Tobotimus added 2 commits Aug 6, 2019
Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
@jack1142

This comment has been minimized.

Copy link
Contributor

commented Aug 7, 2019

If you're not inside an activated virtual environment, include the ``--user`` flag with all

It might not be clear for the user what means adding a flag, so perhaps we could improve this wording too?

Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
@jack1142

This comment has been minimized.

Copy link
Contributor

commented on c4fdc87 Aug 19, 2019

👍

Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
@mikeshardmind

This comment has been minimized.

Copy link
Member

commented Aug 19, 2019

Note on why only outside venv: using py -3.7 is venv-incompatible. py doesn't appear to recognize being in a venv

Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
@mikeshardmind mikeshardmind merged commit 25fb389 into V3/develop Aug 30, 2019
2 checks passed
2 checks passed
Travis CI - Branch Build Passed
Details
Travis CI - Pull Request Build Passed
Details
@mikeshardmind mikeshardmind deleted the V3/update_linux_installdocs branch Aug 30, 2019
@mikeshardmind mikeshardmind added this to the 3.2.0 milestone Sep 13, 2019
@yamikaitou yamikaitou referenced this pull request Oct 4, 2019
1 of 1 task complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.