fix: add venv instructions in docs for beginners#1222
Merged
DawoudSheraz merged 3 commits intooverhangio:releasefrom May 14, 2025
Merged
fix: add venv instructions in docs for beginners#1222DawoudSheraz merged 3 commits intooverhangio:releasefrom
DawoudSheraz merged 3 commits intooverhangio:releasefrom
Conversation
regisb
reviewed
Apr 17, 2025
docs/install.rst
Outdated
| .. _install_binary: | ||
|
|
||
|
|
||
| Virtual Environment (Recommended) |
Contributor
There was a problem hiding this comment.
Let's add this in Requirements section
Contributor
Author
There was a problem hiding this comment.
I have moved this into the Requirements section
DawoudSheraz
approved these changes
May 5, 2025
Contributor
DawoudSheraz
left a comment
DawoudSheraz
left a comment
There was a problem hiding this comment.
nit: the commit type should be docs, not fix.
github-project-automation
bot
moved this from In review
to Done
in Tutor project management
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
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.
Description
This PR updates the installation documentation (install.rst) to recommend using a Python virtual environment when installing Tutor. The update is based on recurring issues observed in the community, such as permission errors on fresh systems, and challenges in managing dependencies. These concerns were raised in Tutor Issue #1198 and discussed in the Open edX Forum, where users reported problems due to system-level Python installations.
Changes
Added a Virtual Environment (Recommended) section under the "Requirements"