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

Documentation - install instructions #1198

Open
MuPp3t33r opened this issue Feb 11, 2025 · 4 comments
Open

Documentation - install instructions #1198

MuPp3t33r opened this issue Feb 11, 2025 · 4 comments

Comments

@MuPp3t33r
Copy link

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 :)

@DawoudSheraz DawoudSheraz moved this from Pending Triage to Backlog in Tutor project management Feb 11, 2025
@regisb
Copy link
Contributor

regisb commented Feb 11, 2025

Related comment: overhangio/tutor-indigo#122 (comment)
Are you working with @misilot by any chance?

@MuPp3t33r
Copy link
Author

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

@regisb
Copy link
Contributor

regisb commented Feb 11, 2025

It's fine, the identical reports do point out that there is a very real need for better docs.

@MuPp3t33r
Copy link
Author

I also just happened to notice the docs say requires "Python >=3.6" while on PyPi it shows "Python >=3.9"
Thought I'd point that out in case it gets missed during the update :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants