Fix volume mounting in debugging instructions

Close #10
This commit is contained in:
Régis Behmo 2020-06-19 11:30:44 +02:00
parent 62e70c45d7
commit 0dc9a211eb

View File

@ -13,19 +13,19 @@ Installation
------------
This plugin requires tutor>=3.6.0. If you have installed tutor from a pre-compiled binary, it already comes bundled with the discovery plugin. Otherwise::
pip install tutor-discovery
Then, to enable this plugin, run::
tutor plugins enable discovery
You will have to re-generate the environment::
tutor config save
The, run migrations::
tutor local init
This last step is unnecessary if you run instead ``tutor local quickstart``.
@ -37,7 +37,7 @@ Creating a user
~~~~~~~~~~~~~~~
The discovery user interface will be available at http://discovery.local.overhang.io for a local test instance, and at ``DISCOVERY_HOST`` (by default: http(s)://discovery.<your lms host>) in production. In order to run commands from the UI, a user must be created::
tutor local run discovery ./manage.py createsuperuser
Then, you must login with this user at http://discovery.local.overhang.io/admin.
@ -48,7 +48,7 @@ Re-indexing courses
~~~~~~~~~~~~~~~~~~~
::
tutor local run discovery ./manage.py refresh_course_metadata --partner_code=dev
tutor local run discovery ./manage.py update_index --disable-change-limit
@ -56,13 +56,13 @@ Caching programs
~~~~~~~~~~~~~~~~
In order to cache programs in the LMS, you will need to manually create a catalog integration. This step should be performed just once::
tutor local run lms ./manage.py lms create_catalog_integrations --enabled \
--internal_api_url=http://discovery:8000 \
--service_username=lms_catalog_service_user
Then::
tutor local run lms ./manage.py lms cache_programs
Debugging
@ -71,22 +71,22 @@ Debugging
To debug the course discovery service, you are encouraged to mount the course-discovery repo from the host in the development container:
tutor dev runserver -v ~/projets/openedx/repos/course-discovery/:/openedx/discovery discovery
You can then access the development server at http://discovery.local.overhang.io:8381. Feel free to add breakpoints (``import pdb; pdb.set_trace()``) anywhere in your source code to debug your application.
Alternatively, you may bind-mount a local course-discovery repository by adding the following to ``$(tutor config printroot)/env/dev/docker-compose.override.yml``::
version: "3.7"
services:
discovery:
volumes:
- /path/to/course-discovery/:/openedx/course-discovery
- /path/to/course-discovery/:/openedx/discovery
discovery-assets:
volumes:
- /path/to/course-discovery/:/openedx/course-discovery
- /path/to/course-discovery/:/openedx/discovery
Once a local repository is mounted in the image, you will have to install nodejs dependencies and collect static assets::
tutor dev run discovery npm install --development
tutor dev run discovery make static.dev