christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-14 17:24:08 +00:00
Code Issues Releases Activity
62ddc01cdc
tutor/docs/tutorials.rst

30 lines
581 B
ReStructuredText
Raw Normal View History

docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`.
2021-09-16 08:53:52 +00:00
Tutorials
=========
Open edX customization
----------------------
.. toctree::
:maxdepth: 2
tutorials/theming
tutorials/edx-platform-settings
docs: add tutorial on using Google Mail as an SMTP server The tutorial comes from the feedback of multiple users, including: https://discuss.overhang.io/t/google-smtp-not-working/2143
2021-11-23 17:16:51 +00:00
tutorials/google-smtp
goodbye "edge" hello "nightly"! In conversations with edX, we learned that the name "edge" had negative undertones for historical reasons. Thus, we switch to "nightly", which means pretty much the same thing.
2021-09-28 16:18:36 +00:00
tutorials/nightly
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`.
2021-09-16 08:53:52 +00:00
System administration
---------------------
.. toctree::
:maxdepth: 2
feat: `k8s scale` command + tutorial - Add a `tutor k8s scale lms 11` command - Create a "Running Open edX at scale" tutorial
2021-11-30 17:02:14 +00:00
tutorials/scale
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`.
2021-09-16 08:53:52 +00:00
tutorials/portainer
docs: move podman install to its own tutorial <rant>I attempted to actually run Tutor with Podman and I was sorely disappointed. The only reliable source of docs that I found concerning the integration with docker-compose is this blog post: https://www.redhat.com/sysadmin/podman-docker-compose There are no other official docs 😓 1. The instructions given in the blog post don't work out of the box. Launching the podman service failed altogether on Ubuntu 20.04 and 20.10. It worked on CentOS 8, but some parameters need to changed, such as the docker socket path. 2. After I got the podman service working, I managed to get an Open edX platform running with tutor, but with the root user. Then, containers complained that they could not write data to the bind-mounted volumes. I attempted to run as a non-root user, and discovered that the podman socket is only readable by root. This should explain why all commands from that blog post are prefixed by sudo. Long story short, I was hoping to update the tutorial. Instead, I'm just moving it for the sake of better organisation. For the life of me, I do not understand why some people would want to run Podman instead of Docker. Bad documentation is an immediate turn-off for me. From my perspective, podman is mostly an overblown marketina stunt.</rant>
2021-09-28 16:11:56 +00:00
tutorials/podman
docs: reorganize local guides in tutorials There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`.
2021-09-16 08:53:52 +00:00
tutorials/proxy
tutorials/datamigration
tutorials/multiplatforms
tutorials/oldreleases
Other tutorials can be found in the official Tutor forums, `in the "Tutorials" category <https://discuss.overhang.io/c/tutor/tutorials/13>`__.
Copy Permalink