diff --git a/source/_images/educator_how_tos/Discussion_tile_in_pages_and_resources.png b/source/_images/educator_how_tos/Discussion_tile_in_pages_and_resources.png index a6e0967c6..3534cb6dc 100644 Binary files a/source/_images/educator_how_tos/Discussion_tile_in_pages_and_resources.png and b/source/_images/educator_how_tos/Discussion_tile_in_pages_and_resources.png differ diff --git a/source/_images/educator_how_tos/Live_app_configuration.png b/source/_images/educator_how_tos/Live_app_configuration.png index a609f532f..062189c1e 100644 Binary files a/source/_images/educator_how_tos/Live_app_configuration.png and b/source/_images/educator_how_tos/Live_app_configuration.png differ diff --git a/source/_images/educator_how_tos/Live_configuration_card.png b/source/_images/educator_how_tos/Live_configuration_card.png index d427653d1..971d25b20 100644 Binary files a/source/_images/educator_how_tos/Live_configuration_card.png and b/source/_images/educator_how_tos/Live_configuration_card.png differ diff --git a/source/educators/how-tos/communication/configure_discussions.rst b/source/educators/how-tos/communication/configure_discussions.rst index 6edb9cc24..218023463 100644 --- a/source/educators/how-tos/communication/configure_discussions.rst +++ b/source/educators/how-tos/communication/configure_discussions.rst @@ -12,6 +12,9 @@ Configure Open edX Discussions To open the Open edX discussions configuration page, follow these steps. +To use a third-party discussion provider instead, see +:ref:`Configure an LTI Discussion Provider`. + 1. Open your course in Studio. 2. Select **Content**, then **Pages & Resources**. @@ -229,5 +232,7 @@ that are anonymous to other learners, as seen below. +--------------+-------------------------------+----------------+--------------------------------+ | Review Date | Working Group Reviewer | Release |Test situation | +--------------+-------------------------------+----------------+--------------------------------+ +| 2026-07-31 | Aamir Ayub | Verawood | Pass | ++--------------+-------------------------------+----------------+--------------------------------+ | 2025-03-20 | Documentation WG | Sumac | Pass | +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/add_course_live.rst b/source/educators/how-tos/course_development/add_course_live.rst index 13164f469..d5692cc02 100644 --- a/source/educators/how-tos/course_development/add_course_live.rst +++ b/source/educators/how-tos/course_development/add_course_live.rst @@ -1,163 +1,120 @@ .. _Course Live: -########################### -Course Live -########################### +######################################################## +Add Live Sessions with an LTI Video Conferencing Tool +######################################################## .. tags:: educator, how-to -Live app can be used to configure video conferencing LTI tools like Zoom -and BigBlueButton. These tools will help connect educators and learners -within the platform. +Add a **Live** page to your course where you can host video +sessions and learners can join them from the course navigation. -*********************************** -Enable or disable course live app -*********************************** -Once course live app has been enabled, and an LTI provider has been -successfully configured, that provider will be accessible in "Live" -tab in course navigation. +You can currently add Zoom and BigBlueButton for live sessions. Both integrations +use LTI 1.1. -1. Go to "Pages & Resources" page and click gear icon on the "Live" configuration card. +************************* +Find the Live settings +************************* -.. image:: /_images/educator_how_tos/Live_configuration_card.png - :width: 200 - :alt: Image of Live configuration card +#. In Studio header, select **Content**, then **Pages & Resources**. -2. Turn on the toggle on top-right to enable the app. +#. On the **Live** card, select the settings icon. -.. image:: /_images/educator_how_tos/Live_app_configuration.png - :width: 300 - :alt: Image of Live app configurations + .. image:: /_images/educator_how_tos/Live_configuration_card.png + :width: 600 + :alt: The Live card on the Pages & Resources page. -3. Select the LTI provider and add credentials (if needed). +#. Enable **Live** from the toggle on the top right of the settings modal. -4. Click "Save" to enable the selected LTI provider. +#. Select Zoom or BigBlueButton. -Once successfully enabled, the LTI provider will be accessible in -"Live" tab in course navigation. + .. image:: /_images/educator_how_tos/Live_app_configuration.png + :width: 600 + :alt: The Live settings with Zoom selected. +#. Complete the steps for your selected tool. -******************************** -Provider specific configuration -******************************** +************** +Configure Zoom +************** -At present, the Open edX platform supports following video conferencing LTI providers: +First, create LTI credentials in Zoom: -#. Zoom -#. Big Blue button +#. Add the `Zoom LTI Pro app + `_ to your Zoom + account. +#. Open the app configuration and add a credential. +#. Name the credential and select **LTI 1.1**. +#. Copy the generated LTI URL, LTI key, and LTI secret. +#. In the credential settings: -LTI setup -========= + * Set **Email or Employee Unique ID Attribute Name** to + ``instructor_email``. + * Add the domain of your Open edX Learning site to **Approved Domains**. + For example, use ``learning.example.com`` if that is where you view your + course. -For more information about configuring LTI tools, see :ref:`About the LTI -Component`. +Then return to the Live settings in Studio: -Zoom setup -========== +#. Enter the Zoom values in the matching fields: -`Zoom LTI pro app `_ -can be used to integrate Zoom video conferencing at the course level. -Course authors will need to generate their own credentials for the Zoom LTI pro -app and add those credentials in Live app configuration for Zoom. + * Enter the LTI key in **Consumer Key**. + * Enter the LTI secret in **Consumer Secret**. + * Enter the LTI URL in **Launch URL**. + * Enter the email address for your Zoom account in **Launch Email**. -Instructors can use the LTI Pro app to schedule and start Zoom meetings and -students can see and join these meetings to attend classes, office hours, study -groups, etc. Learn more about the app -`here `_. +#. Select **Save**. -To generate LTI credentials in LTI pro app: - -1. Add Zoom LTI pro app to your Zoom account. - -2. Navigate to configurations of LTI pro app and add a new credential. - -3. Name the credential and select LTI 1.1. - -4. LTI URL, LTI Secret, and LTI Key will be auto-generated. - -5. In settings of the credential: - - a. Add "instructor_email" to `Email or Employee Unique ID Attribute Name` setting. - - b. Add the link to your Open edX instance's Learning MFE (for example, `learning.myinstance.com` - see the URL when you view your course) to the `Approved Domains` setting. - - -To configure Zoom, navigate to Live app configurations -(see `Enable or disable course live app`): - - -1. Copy LTI URL, LTI Secret, and LTI Key from LTI pro app and paste in LTI input -fields in Live app configuration for Zoom. - -2. Add the email associated with your Zoom account, in "Launch Email" field. - -Once successfully enabled, Zoom will be accessible in "Live" tab in course navigation. +The **Live** page now appears in the course navigation. Course staff can +schedule or start Zoom meetings. Learners can join those meetings. .. image:: /_images/educator_how_tos/Zoom_in_Live_tab.png :width: 600 - :alt: Screenshot of Zoom rendered in Live tab in course navigation - + :alt: Zoom displayed on the Live page in a course. -Big Blue Button setup -====================== +************************* +Configure BigBlueButton +************************* -`Big blue button `_ can be used to create virtual classrooms -for a course. +BigBlueButton offers commercial, and self-hosted options. The +configuration shares the usernames and email addresses of learners and course +staff with BigBlueButton. -Instructors can use the big blue button to schedule and start meetings and students -can see and join these meetings to attend classes. Learn more about -the app on `Big Blue button site `_. +#. Get LTI credentials from your deployment or hosting provider. -Configuration options for BBB are presented below: +#. In the Live settings, select **BigBlueButton**. -#. **Free tier**: You can use BBB for free with certain limitations. See this - `document `_ - to learn more about the free tier. To configure, select the *Free* option in - *Select a plan* dropdown menu and click *Save*. No further configuration - is required. +#. From **Select a plan**, select **Commercial/self-hosted**. -.. image:: /_images/educator_how_tos/course_live_bbb_free.png - :width: 300 +#. Enter the LTI credentials. -#. **Commercial/self-hosted**: You can deploy BBB on your own server or use - third-party hosting providers. Please find more information on features - available in the commercial tier in this - `document `_. You - can use the services listed on this - `link `_. These services provide - complete BBB deployment and support. - Once you have obtained LTI credentials for BBB from your own deployment or via - a third-party provider, select the *Commercial/self-hosted* option in - *Select a plan* dropdown menu, add LTI credentials in respective input fields - and click *Save*. +#. Select **Save**. -If you want to deploy your own server of BBB, please the documentation provided -by BBB in the links below. +For deployment help, see the BigBlueButton documentation: -https://docs.bigbluebutton.org/administration/install +* `Install BigBlueButton + `_ +* `Configure the BigBlueButton LTI integration + `_ +* `Find a BigBlueButton hosting provider + `_ -https://docs.bigbluebutton.org/administration/lti - -Once successfully configured and enabled, BBB will be -accessible in *Live* tab in course navigation. +The **Live** page now appears in the course navigation. Course staff can +create BigBlueButton sessions. Learners can join those sessions. .. image:: /_images/educator_how_tos/BBB_in_live_tab.png :width: 600 - :alt: Screenshot of BBB rendered in Live tab in course navigation - -.. seealso:: - - :ref:`About the LTI Component` (concept) - - :ref:`Determine Content Addresses` (how-to) + :alt: BigBlueButton displayed on the Live page in a course. **Maintenance chart** -+--------------+-------------------------------+----------------+-----------------------------------------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+-----------------------------------------------------------------+ -| 2025-04-13 | Docs WG | Sumac | Pass | -+--------------+-------------------------------+----------------+-----------------------------------------------------------------+ -| 07/03/2025 | Docs WG | Sumac | `Fail `_| -+--------------+-------------------------------+----------------+-----------------------------------------------------------------+ ++--------------+-------------------------------+----------------+--------------------------------------------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+--------------------------------------------------------------------+ +| 2026-07-31 | Aamir Ayub | Verawood | `Fail `_| ++--------------+-------------------------------+----------------+--------------------------------------------------------------------+ +| 2025-04-13 | Docs WG | Sumac | Pass | ++--------------+-------------------------------+----------------+--------------------------------------------------------------------+ +| 07/03/2025 | Docs WG | Sumac | `Fail `_ | ++--------------+-------------------------------+----------------+--------------------------------------------------------------------+ diff --git a/source/educators/how-tos/course_development/configure_lti_discussion_provider.rst b/source/educators/how-tos/course_development/configure_lti_discussion_provider.rst new file mode 100644 index 000000000..c05658a62 --- /dev/null +++ b/source/educators/how-tos/course_development/configure_lti_discussion_provider.rst @@ -0,0 +1,62 @@ +.. _Configure an LTI Discussion Provider: + +#################################### +Configure an LTI Discussion Provider +#################################### + +.. tags:: educator, how-to + +You can use a third-party discussion tool as the **Discussion** page in a +course. Open edX supports these discussion providers through LTI 1.1: + +* Ed Discussion +* InScribe +* Piazza +* Yellowdig + +.. note:: + + Only an Open edX global administrator can select, configure, or change a + third-party discussion provider. + +******************************** +Configure a discussion provider +******************************** + +.. warning:: + + A discussion provider might require the usernames or email addresses of + learners and course staff. Review your organization's privacy and data + policies before enabling PII sharing. + +#. Enable LTI PII sharing for the course. See :ref:`Manage LTI PII Sharing for + a Course`. + +#. In the Studio header, select **Content**, then **Pages & Resources**. + +#. On the **Discussion** card, select the settings icon. + + .. image:: /_images/educator_how_tos/Discussion_tile_in_pages_and_resources.png + :width: 600 + :alt: The Discussion card on the Pages & Resources page. + +#. Select the third-party discussion provider. + +#. Select **Next**. + +#. Enter the **Consumer Key**, **Consumer Secret**, and **Launch URL** supplied + by the provider. + +#. Select **Save**. + +The **Discussion** page in the course navigation now shows the third-party tool +in place of the platform's built-in discussions. + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+----------------+ +| Review Date | Working Group Reviewer | Release | Test situation | ++--------------+-------------------------------+----------------+----------------+ +| 2026-07-31 | Aamir Ayub | Verawood | Pass | ++--------------+-------------------------------+----------------+----------------+ diff --git a/source/educators/how-tos/course_development/configure_resources.rst b/source/educators/how-tos/course_development/configure_resources.rst index c52953a64..1c736ff76 100644 --- a/source/educators/how-tos/course_development/configure_resources.rst +++ b/source/educators/how-tos/course_development/configure_resources.rst @@ -39,10 +39,13 @@ Other providers and configuration options can be selected to fit the needs of co In this step, educators can select to use the default Open edX discussion experience or LTI based integrations with other providers. Below the grid of available providers is a table summarizing the features each integration provides. +For instructions on using a third-party provider, see +:ref:`Configure an LTI Discussion Provider`. + **Step 2: Configuration Options** Each provider supports its own set of features depending on the discussion features they support. The default Open edX discussion application has various settings and controls that are described below. -All integrations use LTI 1.1 configuration, and may additionally support platform settings from the list below. Any special instructions or details specific to a given provider are described in this step as well. +The available settings depend on the selected provider. **Anonymous Posting** @@ -128,6 +131,8 @@ To learn about Flexible Peer Grading and the course override setting, see :ref: +--------------+-------------------------------+----------------+---------------------------------------------------------------+ | Review Date | Working Group Reviewer | Release |Test situation | +--------------+-------------------------------+----------------+---------------------------------------------------------------+ +| 2026-07-31 | Aamir Ayub | Verawood | Pass | ++--------------+-------------------------------+----------------+---------------------------------------------------------------+ | 07/23/2025 | Leira (Curricu.me) | Sumac | Pass | +--------------+-------------------------------+----------------+---------------------------------------------------------------+ | 06/30/2025 | Leira (Curricu.me) | Sumac | Fail (https://github.com/openedx/docs.openedx.org/issues/1154)| diff --git a/source/educators/index.rst b/source/educators/index.rst index cda783cc5..50cfedf8f 100644 --- a/source/educators/index.rst +++ b/source/educators/index.rst @@ -195,11 +195,12 @@ Open edX Educators .. toctree:: :maxdepth: 1 + navigation/creating_course + navigation/content_creation_management + navigation/components_activities navigation/accessibility navigation/advanced_features - navigation/components_activities - navigation/content_creation_management - navigation/creating_course - navigation/data_analytics + navigation/lti navigation/learner_engagement_communication + navigation/data_analytics navigation/olx diff --git a/source/educators/navigation/advanced_features.rst b/source/educators/navigation/advanced_features.rst index fe9bd17a8..c8e6cb5fe 100644 --- a/source/educators/navigation/advanced_features.rst +++ b/source/educators/navigation/advanced_features.rst @@ -75,20 +75,6 @@ Use Teams in Your Course ../concepts/advanced_features/teams_learner_experience.rst -Use Open edX as an LTI Tool Provider -******************************************************* - -.. toctree:: - :maxdepth: 1 - :glob: - - ../concepts/advanced_features/using_openedx_as_LTI_provider.rst - ../references/advanced_features/lti_content_compatibility.rst - ../how-tos/advanced_features/lti_determine_content_address.rst - ../how-tos/advanced_features/lti_canvas_example.rst - ../how-tos/advanced_features/lti_blackboard_example.rst - - Offering Badges ******************************************************* diff --git a/source/educators/navigation/components_activities.rst b/source/educators/navigation/components_activities.rst index ee9a52bfb..27044c5a1 100644 --- a/source/educators/navigation/components_activities.rst +++ b/source/educators/navigation/components_activities.rst @@ -148,21 +148,6 @@ Image Mapped Input Problem ../how-tos/course_development/exercise_tools/create_image_mapped_input.rst ../references/course_development/exercise_tools/image_mapped_input_xml.rst -LTI Component -******************************************************* - -.. toctree:: - :maxdepth: 1 - :glob: - - ../concepts/exercise_tools/about_lti_component.rst - ../how-tos/course_development/exercise_tools/set_up_lti_1_1_component.rst - ../how-tos/course_development/exercise_tools/set_up_lti_1_3_component.rst - ../how-tos/course_development/exercise_tools/setup_lti_reusable_consumer.rst - ../references/course_development/exercise_tools/use_lti_advantage_features.rst - ../references/course_development/exercise_tools/allow_lti_share_pii.rst - - Math Expression Input Problem ******************************************************* diff --git a/source/educators/navigation/learner_engagement_communication.rst b/source/educators/navigation/learner_engagement_communication.rst index 0179f8d69..164db7fcd 100644 --- a/source/educators/navigation/learner_engagement_communication.rst +++ b/source/educators/navigation/learner_engagement_communication.rst @@ -29,6 +29,9 @@ Course Discussions ../how-tos/communication/setup_cohorted_discussions.rst ../references/communication/managing_divided_discussions.rst +To replace Open edX Discussions with a third-party tool, see +:ref:`Configure an LTI Discussion Provider`. + .. _Bulk Emails: Bulk Emails @@ -91,11 +94,8 @@ Course Wiki Adding Live Sessions ******************************************************* -.. toctree:: - :maxdepth: 1 - :glob: - - ../how-tos/course_development/add_course_live.rst +Use an LTI video conferencing tool to host live course sessions. See +:ref:`Course Live`. Embed a Google Calendar ******************************************************* @@ -145,4 +145,4 @@ Word Cloud Tool :maxdepth: 1 :glob: - ../how-tos/course_development/exercise_tools/manage_word_cloud.rst \ No newline at end of file + ../how-tos/course_development/exercise_tools/manage_word_cloud.rst diff --git a/source/educators/navigation/lti.rst b/source/educators/navigation/lti.rst new file mode 100644 index 000000000..194add5ce --- /dev/null +++ b/source/educators/navigation/lti.rst @@ -0,0 +1,15 @@ +:orphan: + +.. _LTI for Educators: + +Learning Tools Interoperability (LTI) +##################################### + +LTI connects an Open edX course with tools and content hosted in another +learning system. Choose a path based on the direction of the integration. + +.. toctree:: + :maxdepth: 1 + + lti_tools + lti_openedx_content diff --git a/source/educators/navigation/lti_course_content.rst b/source/educators/navigation/lti_course_content.rst new file mode 100644 index 000000000..746723550 --- /dev/null +++ b/source/educators/navigation/lti_course_content.rst @@ -0,0 +1,20 @@ +:orphan: + +.. _Add LTI Tools to Course Content: + +Add LTI Tools to Course Content +############################### + +Use an LTI component when learners should open a third-party tool from a unit +in your course. Start with the component overview, then choose the setup method +that matches your tool and Open edX site. + +.. toctree:: + :maxdepth: 1 + + ../concepts/exercise_tools/about_lti_component.rst + ../how-tos/course_development/exercise_tools/set_up_lti_1_3_component.rst + ../how-tos/course_development/exercise_tools/set_up_lti_1_1_component.rst + ../how-tos/course_development/exercise_tools/setup_lti_reusable_consumer.rst + ../references/course_development/exercise_tools/use_lti_advantage_features.rst + ../references/course_development/exercise_tools/allow_lti_share_pii.rst diff --git a/source/educators/navigation/lti_course_navigation.rst b/source/educators/navigation/lti_course_navigation.rst new file mode 100644 index 000000000..12efe245f --- /dev/null +++ b/source/educators/navigation/lti_course_navigation.rst @@ -0,0 +1,16 @@ +:orphan: + +.. _Add LTI Tools to Course Navigation: + +Add LTI Tools to Course Navigation +################################## + +Add a supported LTI tool to the course navigation when learners should open it +as a course-level page. Open edX supports third-party discussion and video +conferencing tools in course navigation. + +.. toctree:: + :maxdepth: 1 + + ../how-tos/course_development/configure_lti_discussion_provider.rst + ../how-tos/course_development/add_course_live.rst diff --git a/source/educators/navigation/lti_openedx_content.rst b/source/educators/navigation/lti_openedx_content.rst new file mode 100644 index 000000000..bbdd3c2b7 --- /dev/null +++ b/source/educators/navigation/lti_openedx_content.rst @@ -0,0 +1,23 @@ +:orphan: + +.. _Use Open edX Content in Another LMS with LTI: + +Use Open edX Content in Another LMS with LTI +############################################# + +Use this path when learners will launch Open edX course content from another +learning management system. In this integration, the Open edX platform acts as +an LTI 1.1 tool provider. + +Your site operator must enable the LTI provider functionality and create +credentials before you can add Open edX content to another learning management +system. + +.. toctree:: + :maxdepth: 1 + + ../concepts/advanced_features/using_openedx_as_LTI_provider.rst + ../references/advanced_features/lti_content_compatibility.rst + ../how-tos/advanced_features/lti_determine_content_address.rst + ../how-tos/advanced_features/lti_canvas_example.rst + ../how-tos/advanced_features/lti_blackboard_example.rst diff --git a/source/educators/navigation/lti_tools.rst b/source/educators/navigation/lti_tools.rst new file mode 100644 index 000000000..39bec5034 --- /dev/null +++ b/source/educators/navigation/lti_tools.rst @@ -0,0 +1,20 @@ +:orphan: + +.. _Add LTI Tools to an Open edX Course: + +Add LTI Tools to an Open edX Course +################################### + +Use this path when learners will launch a third-party LTI tool from an Open edX +course. In this integration, the Open edX platform acts as the LTI platform, +also called the LTI consumer in earlier versions of the standard. + +Choose where learners will open the tool. You can add an LTI component to +course content or add a supported tool to the course navigation. Your site +operator or the tool provider might need to give you configuration values. + +.. toctree:: + :maxdepth: 1 + + lti_course_content.rst + lti_course_navigation.rst diff --git a/source/educators/navigation/olx.rst b/source/educators/navigation/olx.rst index f422121b8..fa44ad4f1 100644 --- a/source/educators/navigation/olx.rst +++ b/source/educators/navigation/olx.rst @@ -157,7 +157,6 @@ This section describes the various exercises, tools, and problem types that you /educators/how-tos/course_development/exercise_tools/add_google_drive.rst /educators/how-tos/course_development/exercise_tools/create_iframe.rst /educators/references/course_development/exercise_tools/image_mapped_input_xml.rst - /educators/concepts/exercise_tools/about_lti_component.rst /educators/references/course_development/exercise_tools/math_expression_input_xml.rst /educators/how-tos/course_development/exercise_tools/add_mathjax.rst /educators/references/course_development/exercise_tools/multi_select_xml.rst @@ -198,4 +197,3 @@ The topics in this section describe how to use OLX (open learning XML) to create /educators/how-tos/advanced_features/manage_content_experiments.rst /educators/how-tos/advanced_features/add_content_experiments_olx.rst ../olx/content-experiments/content_experiments_test_olx.rst -