-
Notifications
You must be signed in to change notification settings - Fork 455
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
Documentation - install instructions #1198
Comments
Related comment: overhangio/tutor-indigo#122 (comment) |
In hindsight I probably should have searched first before opening this, didn't realise I've effectively duplicated an open issue. Sorry! No I wasn't working with Misiliot on this |
It's fine, the identical reports do point out that there is a very real need for better docs. |
I also just happened to notice the docs say requires "Python >=3.6" while on PyPi it shows "Python >=3.9" |
I'd like to propose an edit to the installation instructions (https://github.com/overhangio/tutor/blob/release/docs/install.rst)
Specifically the part referencing the Python installation.
While veteran users should well be familiar with the requirement to set up a venv for the Python install, this might be easily overlooked by new and/or inexperienced users.
Including a footnote, or perhaps a reference to a guide, to setting up virtual environments would probably go a long way for users that are simply following the install guide with minimal experience.
Here is one such example of an instance: https://discuss.openedx.org/t/fresh-ubuntu-install/14974
Thanks :)
The text was updated successfully, but these errors were encountered: