-
-
Notifications
You must be signed in to change notification settings - Fork 154
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
Improve install docs #1760
Improve install docs #1760
Conversation
a3d015f
to
097fa89
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basically LGTM now.
Co-authored-by: David Glick <[email protected]>
I just want to say that I really appreciate this explanation. I have long felt that creating Python virtual environments at the project root was "not right", both in Plone documentation and our tools. Coming from Pyramid, I always used |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor tweaks to grammar, sprinkle some MyST syntax and reference links, and reword a few things.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @MrTango and @davisagli! I'll merge this as soon as it's green.
This corrects the creation of Python venv. We shoud never mix the venv with other configuration like the buildout configuration or others. This can lead to losing data or configuration when updating the venv later.
so instead of
python3 -m venv .
we should use
python3 -m venv venv
or similar to create a venv.
Then either activate the venv or use it like this
./venv/bin/pip install Plone
The buildout bootstrap command is useful to avoid the need to always prefix the buildout run with the venv path later.
It will create the
bin/buildout
script and only need to run once.