feat!: default importdemocourse to the new course & lib #976
Conversation
kdmccormick
force-pushed
the
kdmccormick/new-demo-course
branch
from
0733b74 to
dbe1e0a
Compare
tutor/commands/jobs.py
Outdated
| ./manage.py cms reindex_course --all --setup""" | ||
| template = f"git clone {repo} --branch {version} --depth 1 /tmp/course" | ||
| if library_owner: | ||
| template += f"\nyes | ./manage.py cms import_content_library /tmp/course/{library_tar} {library_owner}" |
There was a problem hiding this comment.
Note to self: if we go with this approach, we should add a -y/--yes option to the import_content_library management command. We can take care of it after this PR is merged.
|
Very much looking forward to this change and seeing the old demo course go away! |
kdmccormick
force-pushed
the
kdmccormick/new-demo-course
branch
from
be6fbb6 to
472697e
Compare
kdmccormick
force-pushed
the
kdmccormick/new-demo-course
branch
from
472697e to
10c712e
Compare
| @@ -0,0 +1,2 @@ | |||
| - 💥 [Feature] `tutor local do importdemocourse` will now import the new [Open edX Demo Course](https://github.com/openedx/openedx-demo-course), which has been rebuilt from scratch. If you wish to import the old demo course instead (which no longer receives updates), you can run: `tutor local do importdemocourse --repo-dir . --version open-release/palm.4`. | |||
There was a problem hiding this comment.
We should replace "palm.4" by "quince.1".
There was a problem hiding this comment.
Does this mean that you need to be on quince.2 to get the new version of the course, or will it be possible to be on an older version of the platform but still import the new course?
There was a problem hiding this comment.
We should replace "palm.4" by "quince.1".
Right, or even quince.master.
Does this mean that you need to be on quince.2 to get the new version of the course, or will it be possible to be on an older version of the platform but still import the new course?
Older versions of Open edX and Tutor will default to the old demo course, but it is possible to import the new demo course into them with the right arguments:
tutor local do importdemocourse --repo-dir demo-course/course --version master
I'll update this message to be clearer about this.
| show_default=True, | ||
| help="Git repository that contains the course to be imported", | ||
| ) | ||
| @click.option( | ||
| "-d", | ||
| "--repo-dir", | ||
| default="", | ||
| default="demo-course/course", |
There was a problem hiding this comment.
This change will cause some existing commands to fail, when users try to import a different custom course that is not stored in a subdirectory:
tutor local do importdemocourse --repo https://github.com/me/mycourse
I wonder if we could simplify the CLI by auto-detecting the location of the "course.xml" file? This would make the import script much more complex. But I see no other option if we want to preserve ease-of-use and compatibility with the new demo course structure.
There was a problem hiding this comment.
Or maybe, for now, if the repo path ends with openedx-demo-course, treat the default as demo-course/course, otherwise ""?
There was a problem hiding this comment.
@regisb I am OK with that complexity. I'll implement this logic:
- If the
--repo-dirargument is provided, use it. - Else:
findthe course.xml file- If there is exactly one course.xml, then use that directory.
- Else if there are 0 or 2+ course.xml files, raise an exception.
@DawoudSheraz The old and new demo course are both stored in the same repo, "openedx-demo-course". "edx-demo-course" has redirected to "openedx-demo-course" a couple years.
|
Closed in favor of #998 |
Description (will be copied into commit)
We're overhauling the Demo Course repo!. That PR will restructure the repo, rebuild the Demo Course from scratch, and a Demo Content Library to accompany the course.
This PR, which should merge right after that one, modifies the existing
tutor (local|dev|k8s) do importdemocoursecommand accordingly:--repo-diroption now defaults to a new subdirectory: demo-course/course.--library-taroption is added, defaulting to the library archive: dist/demo-content-library.tar.gz--library-owneris added as an option. Omitting the option means that the course will import fine, but the library import will be skipped and a warning will be printed. This is OK, as the course works fine without the library.💥 BREAKING CHANGE: The new course is significantly different than the old one. Importing the old demo course remains possible, but with a couple extra arguments:
tutor local do importdemocourse --repo-dir . --version open-release/palm.4.Testing
Run:
Fire up Tutor and go to Studio. On your course listing, you should see the Demo Course, and under your library listing, you should see "Respiratory System Question Bank 1" (that's the demo library). Go to LMS, "Discover New", and choose Axim/DemoX (the one on the right).
Enroll. The outline should look like this: