Skip to content

docs: restructure tutor documentation#1358

Merged
ahmed-arb merged 9 commits intooverhangio:releasefrom
edly-io:docs/restructure_tutor_documentation
Apr 9, 2026
Merged

docs: restructure tutor documentation#1358
ahmed-arb merged 9 commits intooverhangio:releasefrom
edly-io:docs/restructure_tutor_documentation

Conversation

@Faraz32123
Copy link
Copy Markdown
Contributor

@Faraz32123 Faraz32123 commented Mar 18, 2026

continued from #834
I also have this deployed to GH pages from my fork, to see it live go here: https://faraz32123.github.io/tutor/


.. include:: download/pip.rst

Check the "tutor" package on Pypi: https://pypi.org/project/tutor. You will need Python >= 3.9 with pip and the ``libyaml`` development headers. On Ubuntu, these requirements can be installed by running::
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Check the "tutor" package on Pypi: https://pypi.org/project/tutor. You will need Python >= 3.9 with pip and the ``libyaml`` development headers. On Ubuntu, these requirements can be installed by running::
Check the "tutor" package on Pypi: https://pypi.org/project/tutor. You will need Python >= 3.12 with pip and the ``libyaml`` development headers. On Ubuntu, these requirements can be installed by running::

Support for Python <=3.11 is deprecated openedx/openedx-platform#38171

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should probably also be updated on the PyPi page as well since this also states Requires: Python >=3.9

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a similar issue(#1306) in progress, we will make changes to docs accordingly as soon as that issue is resolved.

@bradenmacdonald
Copy link
Copy Markdown
Contributor

@Faraz32123 Thanks for this effort. Are you setting up some sort of redirects or mapping so that existing links will continue to work?

Comment thread docs/concepts/openedx.rst Outdated
Comment thread docs/concepts/tutor.rst Outdated
Comment thread docs/concepts/tutor.rst Outdated
@Abdul-Muqadim-Arbisoft
Copy link
Copy Markdown
Contributor

Abdul-Muqadim-Arbisoft commented Apr 7, 2026

@Faraz32123 Old paths like /install.html, /dev.html, /plugins/intro.html, /tutorials/theming.html, etc. will all 404. This affects links from the Open edX forum, Stack Overflow answers, blog posts, the official docs site, README files, and more.
Fix: Use sphinx-reredirects or a conf.py redirect map to point every old path to its new location.

Comment thread docs/cli.rst Outdated
Comment thread docs/howtutorworks.rst Outdated
Comment thread docs/plugins/index.rst Outdated
Comment thread docs/plugins/index.rst Outdated
Comment thread docs/concepts/openedx.rst Outdated
Comment thread docs/developing/openedx.rst Outdated
Comment thread docs/faq.rst Outdated
Comment thread docs/concepts/tutor.rst Outdated
Comment thread docs/faq.rst Outdated
Comment thread docs/concepts/tutor.rst Outdated
Comment thread docs/concepts/openedx.rst Outdated
Comment thread docs/plugins/index.rst Outdated
@Faraz32123
Copy link
Copy Markdown
Contributor Author

sphinx-reredirects

@Abdul-Muqadim-Arbisoft I already had this in mind based on @bradenmacdonald's comment. Thanks for adding it.

Comment thread docs/k8s.rst
=====================

With the same docker images we created for :ref:`single server deployment <local>` and :ref:`local development <development>`, we can launch an Open edX platform on Kubernetes. Always in 1 click, of course :)
With the same docker images we created for :ref:`single server deployment <local>` and :ref:`local development <openedx_development>`, we can launch an Open edX platform on Kubernetes. Always in 1 click, of course :)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sentence gramtically incorrect

@Faraz32123 Faraz32123 force-pushed the docs/restructure_tutor_documentation branch from fb5fbe9 to 944dc7e Compare April 8, 2026 09:05
@Faraz32123 Faraz32123 force-pushed the docs/restructure_tutor_documentation branch from 944dc7e to eb9f431 Compare April 8, 2026 09:43
@Faraz32123 Faraz32123 force-pushed the docs/restructure_tutor_documentation branch from 25a8348 to d8f3a32 Compare April 8, 2026 13:42
@ahmed-arb ahmed-arb merged commit 69d91f5 into overhangio:release Apr 9, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in Tutor project management Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

7 participants