6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 14:17:46 +00:00
tutor/docs
Kyle McCormick f984361d9c
feat: full edx-platform setup with tutor dev launch -m ...
Before this commit, setting up an edx-platform development environment
took multiple steps:

   tutor dev launch
   tutor dev run --mount=/path/to/edx-platform lms bash
   >> pip install -e .
   >> npm clean-install
   >> openedx-assets build --env=dev

This commit moves the steps under ``run`` into an init task, which
is automatically run by ``launch``. Thus, setup is now one command:

   tutor dev launch --mount=edx-platform

These extra init steps are only applicable when bind-mounting
edx-platform (because bind-mounting the repository overrides
some important artifacts that exist on the image, which must be
re-generated). Thus, the new init tasks exists early if it detects
that it is *not* operating on a bind-mounted repository.

Finally, we try to simplify the Open edX development docs so that
it is clearer how bind-mounting fits into the development process.

These bind-mounts:

* ../build/openedx/themes:/openedx/themes
* ../build/openedx/requirements:/openedx/requirements

existed in the dev lms and cms containers, but they did
not exist in the lms-job and cms-job containers.

This means that themes and requirements that were *built into the
image* would exist in the job containers, but live updates to the
themes and requirements would not apply.

To resolve this, we set ``volumes:`` on the lms-job and cms-job
services so that they match the volumes for the normal lms and
cms services.

Part of: https://github.com/openedx/wg-developer-experience/issues/146
Closes: https://github.com/openedx/wg-developer-experience/issues/152

This works around (but does not close) these related issues:
* https://github.com/openedx/wg-developer-experience/issues/150
* https://github.com/openedx/wg-developer-experience/issues/151
2023-03-15 13:31:49 +01:00
..
_ext feat: migrate to plugins.v1 with filters & actions 2022-04-15 15:30:54 +02:00
download docs: wrap tutor[full] in quotes for zsh compatibility 2022-04-15 09:20:21 +02:00
img feat: upgrade to olive 2022-12-12 16:55:07 +01:00
plugins feat: plugin indexes 2023-02-10 10:06:38 +01:00
reference feat: configure uwsgi through an ini file 2023-03-15 11:19:22 +01:00
tutorials feat: refactor hooks API for simplification 2023-01-31 10:17:58 +01:00
.gitignore Migrate openedx-docker project to Tutor 👩‍🏫 2018-12-26 19:27:08 +01:00
conf.py chore: upgrade requirements 2023-02-09 12:07:09 +01:00
configuration.rst docs: clarify that extra pip requirements are a list, not a string 2023-03-14 18:09:13 +01:00
dev.rst feat: full edx-platform setup with tutor dev launch -m ... 2023-03-15 13:31:49 +01:00
faq.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
gettingstarted.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
index.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
install.rst feat: deprecate "quickstart" and rename to "launch" 2022-09-30 12:05:35 +02:00
intro.rst feat: deprecate "quickstart" and rename to "launch" 2022-09-30 12:05:35 +02:00
k8s.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
local.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
Makefile feat: strongly typed hooks 2022-11-15 14:58:36 +01:00
quickstart.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00
run.rst docs: build docs in CI (and be nitpicky about it) 2021-10-14 12:59:57 +02:00
testimonials.rst v10.0.0 Upgrade to Juniper (2020-06-15) 2020-06-15 10:19:07 +02:00
troubleshooting.rst docs: troubleshoot high memory usage (#810) 2023-03-10 11:20:21 +01:00
tutor.rst ci: simplify release process 2022-11-29 16:46:06 +01:00
whatnext.rst feat: upgrade to olive 2022-12-12 16:55:07 +01:00