Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add link to hosted course demo #52

Merged
merged 1 commit into from
Mar 20, 2024
Merged

docs: Add link to hosted course demo #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 21 additions & 14 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,15 @@ This course is new as of the Redwood (June 2024) release.
Usage
*****

To use this course and its libraries, you will need to import them into an Open edX instance. All new Open edX
instances will get this course installed by default.
To use this course and its libraries, you can:

Manual import
=============
1. Manually Import the course
2. Perform a Scripted import using Tutor
3. Demo the course on `Open edX® Training LMS <https://training.openedx.org/courses/course-v1:Axim+DemoX+Demo_Course/about>`_.


1. Manual import
=================

In Studio:

Expand All @@ -57,10 +61,10 @@ In Studio:
3. Create a course run with the org ``demo``, name ``Course``, and run ``1``.
4. Import ``dist/demo-course.tar.gz`` into the course run.

Scripted import (for Tutor users)
=================================
2. Scripted import (for Tutor users)
=====================================

In the same environment that use to run tutor, execute the command::
In the same environment that you use to run tutor, execute the command::

make import TUTOR=... TUTOR_CONTEXT=... LIBRARY_IMPORT_USER=...

Expand All @@ -80,20 +84,23 @@ Or::
# Import in kubernetes mode, and make bob the library admin.
make import TUTOR_CONTEXT=k8s LIBRARY_IMPORT_USER=bob

Re-generating the importable content
====================================

If you make changes to the course or library OLX and want to re-generate the importable ``.tar.gz`` files, simply run::

make dist
3. Demo on https://training.openedx.org
=========================================
You can experience the course on training.openedx.org. Note that you can only experience the course as a student in this mode.
Enroll at https://training.openedx.org/courses/course-v1:Axim+DemoX+Demo_Course/about.

This will package the OLX into the ``dist`` directory.

Contributing
************

Contributions of bug fixes are welcome. There are two ways you can make changes to this course.

If you make changes to the course or library OLX and want to re-generate the importable ``.tar.gz`` files, simply run::

make dist

This will package the OLX into the ``dist`` directory.

OLX Editing
===========

Expand Down
Loading