Skip to content
Binary file modified source/_images/educator_concepts/Course_Outline_LMS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_images/educator_how_tos/course_export_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/educator_how_tos/link_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_images/educator_how_tos/studio_course_handouts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,7 @@ grades or answers for individual problems, see :ref:`Nav Learner Data`.
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| 03/07/2025 | Docs WG | Sumac | `Fail <https://github.com/openedx/docs.openedx.org/issues/962>`_|
| 2025-04-13 | sarina | Sumac | Pass |
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| 2025-03-07 | Docs WG | Sumac | `Fail <https://github.com/openedx/docs.openedx.org/issues/962>`_|
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ unless it has the latest chronological date of all existing updates.

To add a course update, follow these steps.

#. In Studio, select **Updates** from the **Content** menu.
#. In Studio, select **Updates** from the **Content** menu in the header bar.
#. Create your update in the text editor that opens.

.. note::
Expand All @@ -54,17 +54,12 @@ To add a course update, follow these steps.
has the latest chronological date, it is shown to learners on the
**Course** page, otherwise the update appears on the **Updates** page.

.. image:: /_images/educator_how_tos/course_updates_page_editor.png
:alt: If you select “+ New update”, you see an editor that has many options
for styling in the toolbar.

.. The following step allows installations that use the Open edX mobile apps to send
.. a push notification to the app when an update is added. Alison, DOC-1814,
.. June 2015
.. image:: /_images/educator_how_tos/course_updates_page_editor.png
:alt: If you select “+ New update”, you see an editor that has many options
for styling in the toolbar.


#. Optionally, choose whether to send a notification about your update to
the Open edX mobile app.
#. Optionally, choose whether to send a notification about your update to the Open edX mobile app.

* Learners can choose to turn off notifications for individual courses or
for all courses. The **Course** page continues to show updates.
Expand All @@ -78,9 +73,8 @@ To add a course update, follow these steps.
Add a Course Handout
********************

To add a course handout, you :ref:`upload a file in Studio<Add Course Files>`, then add an entry to a list of handouts, specifying
Course>`, then add an entry to a list of handouts, specifying
the URL to your uploaded file and providing a handout title.
To add a course handout, you first must :ref:`upload a file in Studio<Add Course Files>`, then add an entry to a list of handouts,
specifying the URL to your uploaded file and providing a handout title.

You can open the Studio **Files** page in another browser window to make
this process easier.
Expand All @@ -97,14 +91,20 @@ To add a course handout, follow these steps.
:alt: The **Course Updates** page in Studio, showing the Course Handouts
panel.

#. In the **Course Handouts** panel, select **Edit**.
#. In the **Course Handouts** panel, select the pencil icon in the top right.

#. In the text editor that opens, add the link to your new course handout. Use the link editor to provide
human-readable text to the link.

.. image:: /_images/educator_how_tos/link_editor.png
:width: 500
:alt: The **Course Updates** page in Studio, showing the Course Handouts
panel.

#. In the editor that opens, add the link to your new course handout.

#. Select **Save**.

.. seealso::


:ref:`About Course Updates and Handouts` (concept)

Expand All @@ -114,5 +114,7 @@ To add a course handout, follow these steps.
+--------------+-------------------------------+----------------+-------------------------------------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+-------------------------------------------------------------+
| 03/17/2025 | Leira (Curricu.me) | Sumac |Fail (https://github.com/openedx/docs.openedx.org/issues/939)|
| 2025-04-13 | sarina | Sumac | Pass |
+--------------+-------------------------------+----------------+-------------------------------------------------------------+
| 2025-03-17 | Leira (Curricu.me) | Sumac |Fail (https://github.com/openedx/docs.openedx.org/issues/939)|
+--------------+-------------------------------+----------------+-------------------------------------------------------------+
13 changes: 8 additions & 5 deletions source/educators/how-tos/copy_paste_units.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,13 @@ From the Unit Page

:ref:`The Unit Workflow` (reference)


**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| | | | |
+--------------+-------------------------------+----------------+--------------------------------+
+--------------+-------------------------------+----------------+---------------------------------------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+---------------------------------------------------------------+
| 2025-04-13 | sarina | Sumac | Pass |
+--------------+-------------------------------+----------------+---------------------------------------------------------------+
| 2025-03-07 | Docs WG | Sumac | Fail (https://github.com/openedx/docs.openedx.org/issues/951) |
+--------------+-------------------------------+----------------+---------------------------------------------------------------+
16 changes: 12 additions & 4 deletions source/educators/how-tos/course_development/add_course_live.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,15 @@ Once successfully enabled, the LTI provider will be accessible in
Provider specific configuration
********************************

At present, the Open edX platform supports following video conferencing LTI provider:
1. Zoom
2. Big Blue button
At present, the Open edX platform supports following video conferencing LTI providers:

#. Zoom
#. Big Blue button

LTI setup
=========

For enabling LTI components, see :ref:`enable_lti_components`.

Zoom setup
==========
Expand Down Expand Up @@ -150,5 +156,7 @@ accessible in *Live* tab in course navigation.
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| 03/07/2025 | Docs WG | Sumac | `Fail <https://github.com/openedx/docs.openedx.org/issues/956>`_|
| 2025-04-13 | Docs WG | Sumac | Pass |
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| 07/03/2025 | Docs WG | Sumac | `Fail <https://github.com/openedx/docs.openedx.org/issues/956>`_|
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ This section describes how you can contribute to the course wiki.

.. START MANAGING WIKI ARTICLES

View Live Course
*****************

To begin, :ref:`view the live version of your course <View Published Content>`.

*********************
Add a Wiki Article
*********************
Expand Down Expand Up @@ -165,5 +170,7 @@ Combine a Current Version with a Previous Version
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
| 03/20/2025 | Leira (Curricu.me) | Sumac | Fail (https://github.com/openedx/docs.openedx.org/issues/967)|
| 2025-04-13 | sarina | Sumac | Pass |
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
| 2025-03-20 | Leira (Curricu.me) | Sumac | Fail (https://github.com/openedx/docs.openedx.org/issues/967)|
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
32 changes: 21 additions & 11 deletions source/educators/how-tos/course_development/manage_course_wiki.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Manage the Course Wiki
.. tags:: educator, how-to

Wikis provide a way for the course team and learners to access, share, and
collaboratively edit information both about, and for, your course.
collaboratively edit information both about, and for, your course. In order
to access the course wiki, :ref:`view the live version of your course<View Published Content>`.

.. contents::
:depth: 1
Expand All @@ -23,12 +24,17 @@ To disable or enable the Wiki application, follow these steps.
#. In Studio, from the **Content** menu select **Pages & Resources**.
#. Click the gear icon on the **Wiki** card shown on this page.
#. From the **Configure wiki** modal, select the toggle to enable or disable the **wiki**.
#. Select **Apply** to save your configuration changes.
#. Select **Save** to save your configuration changes.

.. image:: /_images/educator_how_tos/configure_wiki.png
:width: 600
:alt: The modal shown where you can toggle the wiki and press the "Save" button.


When you hide the wiki in your course, any existing articles remain in the wide wiki,
but the Wiki page is removed from your course pages.

.. In XML authoring, remove the `{"type": "wiki"}` entry in your `/policies/TERM/policy.json` file.
When authoring in :ref:`OLX TOC`, remove the ``{"type": "wiki"}`` entry in your ``/policies/TERM/policy.json`` file.

.. _Controlling Wiki Access:

Expand Down Expand Up @@ -72,7 +78,7 @@ the wide wiki, and cannot be found within the course wiki).

To modify the permissions for wiki articles, follow these steps.

#. View the live version of your course.
#. :ref:`View the live version of your course<View Published Content>`.
#. Select **Wiki**.
#. Navigate to the article whose permissions you are modifying, and then select
**Settings**.
Expand Down Expand Up @@ -131,12 +137,14 @@ Locking a wiki article prevents further changes from being made to it. To lock
a wiki article either after you create it, or after you make specific edits,
follow these steps.

.. If you only lock an article without modifying the read/write permissions,
.. other users can still create wiki articles at the top level. They also appear
.. still to have an Edit button at the top level, but they get Permission Denied
.. when they click Edit.
.. note::

#. View the live version of your course.
If you only lock an article without modifying the read/write permissions,
other users can still create wiki articles at the top level. They also appear
still to have an Edit button at the top level, but they get Permission Denied
when they click Edit.

#. :ref:`View the live version of your course<View Published Content>`.
#. Select **Wiki**.
#. Navigate to the article you want to lock, and then select **Settings**.
#. In the **Permissions** section of the **Settings** page, select the **Lock
Expand All @@ -156,10 +164,10 @@ required permissions, you see a **Delete article** button at the bottom of the

To delete an article, follow these steps.

#. View the live version of your course.
#. :ref:`View the live version of your course<View Published Content>`.
#. Select **Wiki**.
#. Navigate to the article you want to delete, and then select **Edit**.
#. Select **Delete article**.
#. Select **Delete article** at the very bottom of the page.
#. On the deletion confirmation page, select **Yes, I am sure**.
#. Optionally, also select the **Purge** checkbox. For details, see
:ref:`Purging a Wiki Article`.
Expand Down Expand Up @@ -206,5 +214,7 @@ To restore a deleted article, select the link to the article and select
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
| 2025-04-13 | sarina | Sumac | Pass |
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
| 03/20/2025 | Leira (Curricu.me) | Sumac | Fail (https://github.com/openedx/docs.openedx.org/issues/963)|
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
10 changes: 9 additions & 1 deletion source/educators/how-tos/data/view_anonymized_learner_ids.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ View Anonymized Learner IDs

.. tags:: educator, how-to

.. admonition:: Course Data Researcher role required

Be sure your account has the :ref:`Course Data Researcher Role` applied in order to complete this how-to.

Some of the tools that are available for use with the Open edX platform, including
external graders and surveys, work with anonymized learner data. If it becomes
necessary for you to deanonymize previously anonymized data, you can download a
Expand Down Expand Up @@ -42,11 +46,15 @@ the ``{course_id}_student_profile_info_{date}.csv`` file of learner data or the

:ref:`Manage Learner Grades <Grades>` (how-to)

:ref:`Add Course Team Members` (how-to)


**Maintenance chart**

+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| 03/07/2025 | Docs WG | Sumac | `Fail <https://github.com/openedx/docs.openedx.org/issues/979>`_|
| 2025-04-13 | sarina | Sumac | Pass |
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| 2025-03-07 | Docs WG | Sumac | `Fail <https://github.com/openedx/docs.openedx.org/issues/979>`_|
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
17 changes: 12 additions & 5 deletions source/educators/how-tos/data/view_answer_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ View Answer Data

.. tags:: educator, how-to

.. admonition:: Course Data Researcher role required

Be sure your account has the :ref:`Course Data Researcher Role` applied in order to complete this how-to.

To review learner answers to the problems in your course, you can review the
answer submitted by a selected learner for a specific problem or download a
course-wide report of any learner answers to a specific problem. You can also
Expand Down Expand Up @@ -498,11 +502,14 @@ answer(s) can guide future changes to the course content.

:ref:`Answer_Report_FAQ` (reference)

:ref:`Add Course Team Members` (how-to)


**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| | | | |
+--------------+-------------------------------+----------------+--------------------------------+
+--------------+-------------------------------+----------------+---------------------------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+---------------------------------------------------+
| 2025-04-13 | sarina | Sumac |Added note about needing the Data Researcher role. |
| | | |This page still needs to be tested. |
+--------------+-------------------------------+----------------+---------------------------------------------------+
10 changes: 9 additions & 1 deletion source/educators/how-tos/data/view_certificate_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ View Certificate Data

.. tags:: educator, how-to

.. admonition:: Course Data Researcher role required

Be sure your account has the :ref:`Course Data Researcher Role` applied in order to complete this how-to.

You can view data about the certificates that have been issued for your course
in the LMS by selecting **Instructor** to access the instructor dashboard. You
can also download a .csv (comma-separated values) file with the certificate
Expand Down Expand Up @@ -54,12 +58,16 @@ To download certificate data, follow these steps.

:ref:`Guide to the Certificate Report` (reference)

:ref:`Add Course Team Members` (how-to)



**Maintenance chart**

+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| 03/07/2025 | Docs WG | Sumac | `Fail <https://github.com/openedx/docs.openedx.org/issues/978>`_|
| 2025-04-13 | sarina | Sumac | Pass |
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
| 2025-03-07 | Docs WG | Sumac | `Fail <https://github.com/openedx/docs.openedx.org/issues/978>`_|
+--------------+-------------------------------+----------------+-----------------------------------------------------------------+
Loading