From 34806d5d00b25aebc7ae34bb13244f48a8b034b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Mon, 30 Dec 2024 13:48:31 -0500 Subject: [PATCH 1/3] FC-0068 docs: How-to cleaning by edunext #9 This PR modifies a series of how-to documents migrated from the legacy repositories to the educators' documentation. Also creates some how-tos from the managing_cohorts document and modifies the Glossary from educators. --- .../how-tos/advanced_features/add_cohorts.rst | 83 +++ .../assign_learners_cohort_csv.rst | 207 ++++++++ .../assign_learners_cohort_manually.rst | 89 ++++ .../chage_learner_cohort_assignment.rst | 60 +++ .../change_assignment_method_cohort.rst | 76 +++ .../advanced_features/disable_cohorts.rst | 70 +++ .../advanced_features/enable_cohorts.rst | 56 ++ .../advanced_features/managing_cohorts.rst | 490 +----------------- .../advanced_features/rename_cohort.rst | 57 ++ .../course_development/add_course_live.rst | 17 +- .../export_import_library.rst | 14 +- .../navigation/advanced_features.rst | 8 + source/educators/references/glossary.rst | 289 ++++------- 13 files changed, 855 insertions(+), 661 deletions(-) create mode 100644 source/educators/how-tos/advanced_features/add_cohorts.rst create mode 100644 source/educators/how-tos/advanced_features/assign_learners_cohort_csv.rst create mode 100644 source/educators/how-tos/advanced_features/assign_learners_cohort_manually.rst create mode 100644 source/educators/how-tos/advanced_features/chage_learner_cohort_assignment.rst create mode 100644 source/educators/how-tos/advanced_features/change_assignment_method_cohort.rst create mode 100644 source/educators/how-tos/advanced_features/disable_cohorts.rst create mode 100644 source/educators/how-tos/advanced_features/enable_cohorts.rst create mode 100644 source/educators/how-tos/advanced_features/rename_cohort.rst diff --git a/source/educators/how-tos/advanced_features/add_cohorts.rst b/source/educators/how-tos/advanced_features/add_cohorts.rst new file mode 100644 index 000000000..5feb6a526 --- /dev/null +++ b/source/educators/how-tos/advanced_features/add_cohorts.rst @@ -0,0 +1,83 @@ +.. _Add Cohorts: + +Adding Cohorts +################ + +.. tags:: educator, how-to + +After you :ref:`enable the cohorts` feature for your course, you can add cohorts. To +add a cohort to your course, follow these steps. + +#. In the LMS, select **Instructor**, then select **Cohorts**. + +#. Click **Add Cohort**. + +#. Enter a name for the cohort. + + .. note:: + Learners can see the name of the cohort they are assigned to. The message + "This post is visible only to {cohort name}" appears with each post in + discussion topics that are divided by cohort. See :ref:`Read the Group + Indicator in Posts`. + +#. Specify whether learners are automatically or manually assigned to this + cohort. + +#. Optionally, select **Select a Content Group** to associate the cohort with a + :ref:`content group`. For information about creating + cohort-specific course content by associating cohorts with content groups, + see :ref:`Cohorted Courseware Overview`. + +#. Select **Save**. + +Continue implementing your cohort strategy by creating additional cohorts as +applicable, and specifying the assignment method for each cohort. + +.. note:: By the time your course starts, you must have at least one cohort in + your course that is automatically assigned. If you have not created at + least one automated assignment cohort in the course by the time that the + first learner accesses your course content or a divided discussion topic, + Open edX creates a default cohort to which learners are automatically assigned. + +For details about adding learners to a cohort by uploading a .csv file, see +:ref:`Assign Learners to Cohort Groups by uploading CSV`. + +For a report that includes the cohort assignment for every enrolled +learner, review the learner profile information for your course. See +:ref:`View and download student data`. + +.. note:: You cannot delete cohorts, but you can change their names or the way + in which learners are assigned to them. If you need to make changes to the + way you have configured cohorts while your course is running, see + :ref:`Altering Cohort Configuration`. + +.. seealso:: + :class: dropdown + + :ref:`Cohorts Overview` (concept) + + :ref:`Manage Course Cohorts` (how-to) + + :ref:`Enable Cohorts` (how-to) + + :ref:`Assign Learners to Cohorts Manually` (how-to) + + :ref:`Assign Learners to Cohort Groups by uploading CSV` (how-to) + + :ref:`Changing Student Cohort Assignments` (how-to) + + :ref:`Renaming a Cohort` (how-to) + + :ref:`Changing the Assignment Method of a Cohort` (how-to) + + :ref:`Disabling the Cohort Feature` (how-to) + + :ref:`Create Cohort Specific Course Content` (how-to) + + :ref:`About Divided Discussions` (concept) + + :ref:`Managing Divided Discussion Topics` (concept) + + :ref:`Moderating_discussions` (concept) + + :ref:`Setting Up Divided Discussions` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/advanced_features/assign_learners_cohort_csv.rst b/source/educators/how-tos/advanced_features/assign_learners_cohort_csv.rst new file mode 100644 index 000000000..8ab3e6bd7 --- /dev/null +++ b/source/educators/how-tos/advanced_features/assign_learners_cohort_csv.rst @@ -0,0 +1,207 @@ +.. _Assign Learners to Cohort Groups by uploading CSV: + +Assign Learners to Cohorts by Uploading a .csv File +###################################################### + +.. tags:: educator, how-to + +Uploading a .csv file containing a list of learners and the cohorts that you +want to assign them to is another way of assigning learners to cohorts +manually. For details about the other manual assignment method, see +:ref:`Assign Learners to Cohorts Manually`.¿ + +Any assignments to cohorts that you specify in the .csv files you upload will +overwrite or change existing cohort assignments. The configuration of your +cohorts should be complete and stable before your course begins. You should +complete manual cohort assignments as soon as possible after any learner +enrolls, especially for enrollments that occur after your course has started. +To understand the effects of changing cohort assignments after your course has +started, see :ref:`Altering Cohort Configuration`. + +.. note:: Be aware that the contents of the .csv file are processed row by + row, from top to bottom, and each row is treated independently. If the same + learner is assigned to different cohorts in different rows in the + spreadsheet, the last assignment to be performed is that learner's final + assignment. + + For example, if in your .csv file Learner A is first assigned to Cohort 1, + then later in the spreadsheet is assigned to Cohort 2, the end result of + your .csv upload is that Learner A is assigned to Cohort 2. However, the + upload results file will include Learner A twice in the "Learners Added" + count: once when they are added to Cohort 1, and again when they are added + to Cohort 2. Before submitting a file for upload, check it carefully for + duplicated learners and other errors. + + If the same learner is assigned to a cohort that they already belong to, + they are not included in the count of "Learners Added". + + +The requirements for the .csv file are summarized in this table. + +.. list-table:: + :widths: 15 30 + + * - **Requirement** + - **Notes** + * - Valid .csv file + + - The file must be a properly formatted comma-separated values file: + + * The file extension is .csv. + * Every row must have the same number of commas, whether or not there + are values in each cell. + + * - File size + - The file size of .csv files for upload is limited to a maximum of 2MB. + + * - UTF-8 encoded + - You must save the file with UTF-8 encoding so that Unicode characters + display correctly. + + See :ref:`Creating a Unicode Encoded CSV File`. + + * - Header row + - You must include a header row, with column names that exactly match + those specified in "Columns" below. + + * - One or two columns identifying learners + - You must include at least one column identifying learners: + either "email" or "username", or both. + + To preassign learners who do not yet have accounts in your Open edX instance, you must + provide their email addresses in an "email" column. + + If both the username and an email address are provided for a learner, + the email address has precedence. In other words, if an email address + is present, an incorrect or unrecognized username is ignored. + + * - One column identifying the cohort + - You must include one column named "cohort" to identify the cohort + to which you are assigning each learner. + + The specified cohorts must already exist in Studio. + + * - + - Columns with headings other than "email", "username" and "cohort" are + ignored. + + +To manually add learners to cohorts by uploading a .csv file, follow these +steps. + +.. note:: To add learners who do not yet have accounts in your Open edX instance to cohorts using a + .csv file upload, you must provide their email addresses in a column with + the heading "email". Learners without accounts are "preassigned" to + cohorts; they are not included in the count of learners "added" to cohorts. + +#. View the live version of your course. For example, in Studio, select **View + Live**. + +#. Select **Instructor**, then select **Cohorts**. + +#. From the **Select a cohort** list, select the cohort to which you are adding + students. + +#. Select **Assign students to cohorts by uploading a CSV file**, then select + **Browse** to navigate to the .csv file you want to upload. + +#. Select **Upload File and Assign Students**. A status message is displayed + above the **Browse** button. + +#. Verify your upload results on the **Data Download** page. + + Under **Reports Available for Download**, locate the link to a .csv file + with "cohort_results" and the date and time of your upload in the filename. + The list of available reports is sorted chronologically, with the most + recently generated files at the top. + +The results file provides the following information: + +.. list-table:: + :widths: 15 30 + + * - **Column** + - **Description** + + * - Cohort + - The name of the cohort to which you are assigning learners. + + * - Exists + - Whether the cohort was found in the system. TRUE/FALSE. + + If the cohort was not found (value is FALSE), no action is taken for + learners who you assigned to that cohort in the .csv file. + + * - Learners Added + - The number of learners added to the cohort during the row by row + processing of the .csv file. This number does not include learners who + are not enrolled in the course. + + * - Learners Not Found + - A list of the usernames of learners that could not be matched and who + were therefore not added to the cohort. + + * - Invalid Email Addresses + - A list of email addresses that were not valid. These learners could + not be added to the cohort. + + * - Preassigned Learners + - The email addresses of learners who do not yet have an account in your Open edX instance but + who you have preassigned to a cohort using their email addresses. + These learners are not included in the count of "Learners Added". When + these preassigned learners create an account and enroll in your + course, they are automatically added to the cohorts that you + preassigned them to. + + +For a report that includes the cohort assignment for every enrolled learner, +review the learner profile information for your course. See :ref:`View and +download student data`. + + +.. _Creating a Unicode Encoded CSV File: + +Creating a Unicode-encoded .csv File +************************************* + +Make sure the .csv files that you upload are encoded as UTF-8, so that any +Unicode characters are correctly saved and displayed. + +.. note:: Some spreadsheet applications (for example, MS Excel) do not allow + you to specify encoding when you save a spreadsheet as a .csv file. To + ensure that you are able to create a .csv file that is UTF-8 encoded, use a + spreadsheet application such as Google Sheets, LibreOffice, or Apache + OpenOffice. + + + +.. seealso:: + :class: dropdown + + :ref:`Cohorts Overview` (concept) + + :ref:`Manage Course Cohorts` (how-to) + + :ref:`Enable Cohorts` (how-to) + + :ref:`Add Cohorts` (how-to) + + :ref:`Assign Learners to Cohorts Manually` (how-to) + + :ref:`Changing Student Cohort Assignments` (how-to) + + :ref:`Renaming a Cohort` (how-to) + + :ref:`Changing the Assignment Method of a Cohort` (how-to) + + :ref:`Disabling the Cohort Feature` (how-to) + + :ref:`Create Cohort Specific Course Content` (how-to) + + :ref:`About Divided Discussions` (concept) + + :ref:`Managing Divided Discussion Topics` (concept) + + :ref:`Moderating_discussions` (concept) + + :ref:`Setting Up Divided Discussions` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/advanced_features/assign_learners_cohort_manually.rst b/source/educators/how-tos/advanced_features/assign_learners_cohort_manually.rst new file mode 100644 index 000000000..20e3b05a4 --- /dev/null +++ b/source/educators/how-tos/advanced_features/assign_learners_cohort_manually.rst @@ -0,0 +1,89 @@ +.. _Assign Learners to Cohorts Manually: + +Assign Learners to Cohorts Manually +#################################### + +.. tags:: educator, how-to + +If you have implemented a manual assignment strategy for cohorts in your +course, make sure your manual assignments are as complete as possible before +your course starts. If learners enroll after your course starts, you should +assign new learners to cohorts as soon as possible. + +.. note:: Making changes to cohort assignments after the course starts can + affect the course experience for learners. Learners might no longer have + access to course and discussion topics that were previously visible to + them. For more information, see :ref:`Altering Cohort Configuration`. + +To manually assign learners to cohorts in your course, follow these steps. + +#. View the live version of your course. For example, in Studio click **View + Live**. + +#. Select **Instructor**, then select **Cohorts**. + +#. Scroll to the **Cohort Management** section at the bottom. + +#. From the **Select a cohort** list, select the cohort to which you want to + manually assign learners. + +#. On the **Manage Learners** tab, under **Add learners to this cohort** enter + the username or email address of a single learner, or enter multiple + usernames or addresses separated by commas or new lines. You can copy data + from a .csv file of email addresses or usernames, and paste it into this + field. + +#. Select **Add Learners**. + + Learners you added with accounts in your Open edX instance are assigned to the selected + cohorts. A confirmation message indicates the number of learners who were + successfully added to the cohort. + + Learners you added who do not yet have accounts in your Open edX instance are listed as + "Preassigned" to the cohort. When preassigned learners enroll in the + course, they are automatically added to the cohort. + + If some learners that you listed could not be added to cohorts, an error + message lists the email addresses or usernames of learners who could not be + added to the cohort. + +.. note:: Because learners can belong to only one cohort, adding a learner to a + cohort moves them from any cohort they were previously assigned to. The + confirmation message indicates the number of learners who were moved from + their previous cohort assignment as a result of your adding them to the + current cohort. + +For a report that includes cohort assignments for your course, review the +learner profile information for your course. See :ref:`View and download +student data`. + +.. seealso:: + :class: dropdown + + :ref:`Cohorts Overview` (concept) + + :ref:`Manage Course Cohorts` (how-to) + + :ref:`Enable Cohorts` (how-to) + + :ref:`Add Cohorts` (how-to) + + :ref:`Assign Learners to Cohort Groups by uploading CSV` (how-to) + + :ref:`Changing Student Cohort Assignments` (how-to) + + :ref:`Renaming a Cohort` (how-to) + + :ref:`Changing the Assignment Method of a Cohort` (how-to) + + :ref:`Disabling the Cohort Feature` (how-to) + + :ref:`Create Cohort Specific Course Content` (how-to) + + :ref:`About Divided Discussions` (concept) + + :ref:`Managing Divided Discussion Topics` (concept) + + :ref:`Moderating_discussions` (concept) + + :ref:`Setting Up Divided Discussions` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/advanced_features/chage_learner_cohort_assignment.rst b/source/educators/how-tos/advanced_features/chage_learner_cohort_assignment.rst new file mode 100644 index 000000000..5680eb209 --- /dev/null +++ b/source/educators/how-tos/advanced_features/chage_learner_cohort_assignment.rst @@ -0,0 +1,60 @@ +.. _Changing Student Cohort Assignments: + +Change Learner Cohort Assignments +################################## + +.. tags:: educator, how-to + +After your course starts and learners begin to contribute to the course +discussion, each post that they add is visible either to everyone or to the +members of a single cohort. When you change the cohort that a learner is +assigned to, there are three results. + +* The learner continues to see the posts that are visible to everyone. + +* The learner sees the posts that are visible to his new cohort. + +* The learner no longer sees the posts that are visible only to his original + cohort. + +The visibility of a post and its responses and comments does not change, even +if the cohort assignment of its author changes. To a learner, it can seem that +posts have "disappeared". + +To verify the cohort assignments for your learners, download the :ref:`student +profile report` for your course. If changes are +needed, you can :ref:`assign learners` to +different cohorts manually in the LMS by selecting **Instructor** and then +**Cohorts**, or :ref:`upload cohort assignment changes` in a .csv file. + +.. seealso:: + :class: dropdown + + :ref:`Cohorts Overview` (concept) + + :ref:`Manage Course Cohorts` (how-to) + + :ref:`Enable Cohorts` (how-to) + + :ref:`Add Cohorts` (how-to) + + :ref:`Assign Learners to Cohorts Manually` (how-to) + + :ref:`Assign Learners to Cohort Groups by uploading CSV` (how-to) + + :ref:`Renaming a Cohort` (how-to) + + :ref:`Changing the Assignment Method of a Cohort` (how-to) + + :ref:`Disabling the Cohort Feature` (how-to) + + :ref:`Create Cohort Specific Course Content` (how-to) + + :ref:`About Divided Discussions` (concept) + + :ref:`Managing Divided Discussion Topics` (concept) + + :ref:`Moderating_discussions` (concept) + + :ref:`Setting Up Divided Discussions` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/advanced_features/change_assignment_method_cohort.rst b/source/educators/how-tos/advanced_features/change_assignment_method_cohort.rst new file mode 100644 index 000000000..a09df0f26 --- /dev/null +++ b/source/educators/how-tos/advanced_features/change_assignment_method_cohort.rst @@ -0,0 +1,76 @@ +.. _Changing the Assignment Method of a Cohort: + +Changing the Assignment Method of a Cohort +########################################### + +.. tags:: educator, how-to + +Although you can change the assignment method of a cohort at any time after you +create it, you should have a strategy in mind as you design your course, and +only make changes to cohorts while the course is running if absolutely +necessary. Be aware of the implications of changing cohort configuration while +your course is running. For more information, see :ref:`Options for Assigning +Learners to Cohorts` and :ref:`Altering Cohort Configuration`. + +.. note:: When your course starts, you must have at least one cohort in your + course that has automatic assignment. If you have not created at least one + automated assignment cohort in the course by the time that the first learner + accesses your course content, Open edX creates a default cohort to which learners + are automatically assigned. If the :ref:`default group` is the only automated assignment cohort in your course, you cannot + change its assignment method to **Manual**. + +To change the assignment method of a cohort, follow these steps. + +#. View the live version of your course. For example, in Studio select **View + Live**. + +#. Select **Instructor**, then select **Cohorts**. + +#. From the **Select a cohort** list, select the cohort whose assignment method + you want to change. + +#. On the **Settings** tab, the current assignment method is selected. Change + the assignment method by selecting the other option, either **Automatic** or + **Manual**. + +#. Select **Save**. + + The cohort assignment method is updated. + +.. note:: Changing the cohort assignment method has no effect on learners who + are already assigned to this and other cohorts. Learners who access the + course after you make this change are assigned to cohorts based on the new + assignment method of this cohort combined with the assignment methods of all + other cohorts. + +.. seealso:: + :class: dropdown + + :ref:`Cohorts Overview` (concept) + + :ref:`Manage Course Cohorts` (how-to) + + :ref:`Enable Cohorts` (how-to) + + :ref:`Add Cohorts` (how-to) + + :ref:`Assign Learners to Cohorts Manually` (how-to) + + :ref:`Assign Learners to Cohort Groups by uploading CSV` (how-to) + + :ref:`Changing Student Cohort Assignments` (how-to) + + :ref:`Renaming a Cohort` (how-to) + + :ref:`Disabling the Cohort Feature` (how-to) + + :ref:`Create Cohort Specific Course Content` (how-to) + + :ref:`About Divided Discussions` (concept) + + :ref:`Managing Divided Discussion Topics` (concept) + + :ref:`Moderating_discussions` (concept) + + :ref:`Setting Up Divided Discussions` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/advanced_features/disable_cohorts.rst b/source/educators/how-tos/advanced_features/disable_cohorts.rst new file mode 100644 index 000000000..a1b0076d8 --- /dev/null +++ b/source/educators/how-tos/advanced_features/disable_cohorts.rst @@ -0,0 +1,70 @@ +.. _Disabling the Cohort Feature: + +Disable Cohorts in Your Course +############################### + +.. tags:: educator, how-to + +.. warning:: Be very careful in deciding to disable the cohort feature if you + previously had it enabled in a live course, because doing so affects the + course experience for learners. Course materials and discussion posts that + were shared only with members of particular cohorts are now visible to all + learners in the course. + + If you must make changes to the way you have configured cohorts while your + course is running, be sure you understand the consequences of doing so. For + details, see :ref:`Altering Cohort Configuration`. + +To disable cohorts in your course, follow these steps. + +#. In the LMS, select **Instructor**, then select **Cohorts**. + +#. Clear the **Enable Cohorts** option. + +All course content and discussion posts that were previously divided by cohort +immediately become visible to all students. + +.. _Deleting a Cohort: + +Delete a Cohort +***************** + +You cannot delete cohorts. However, you can :ref:`rename a cohort`, :ref:`change its assignment method`, or move learners to other cohorts. + +If you decide that you must alter cohort configuration after your course starts +and learners begin viewing the course and the discussion topics, be sure that +you understand the consequences of these actions. For more details, see +:ref:`Altering Cohort Configuration`. + +.. seealso:: + :class: dropdown + + :ref:`Cohorts Overview` (concept) + + :ref:`Manage Course Cohorts` (how-to) + + :ref:`Enable Cohorts` (how-to) + + :ref:`Add Cohorts` (how-to) + + :ref:`Assign Learners to Cohorts Manually` (how-to) + + :ref:`Assign Learners to Cohort Groups by uploading CSV` (how-to) + + :ref:`Changing Student Cohort Assignments` (how-to) + + :ref:`Renaming a Cohort` (how-to) + + :ref:`Changing the Assignment Method of a Cohort` (how-to) + + :ref:`Create Cohort Specific Course Content` (how-to) + + :ref:`About Divided Discussions` (concept) + + :ref:`Managing Divided Discussion Topics` (concept) + + :ref:`Moderating_discussions` (concept) + + :ref:`Setting Up Divided Discussions` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/advanced_features/enable_cohorts.rst b/source/educators/how-tos/advanced_features/enable_cohorts.rst new file mode 100644 index 000000000..7ff1e2b68 --- /dev/null +++ b/source/educators/how-tos/advanced_features/enable_cohorts.rst @@ -0,0 +1,56 @@ +.. _Enable Cohorts: + +Enabling Cohorts in your Course +################################# + +.. tags:: educator, how-to + +To enable cohorts in your course, follow these steps. + +#. In the LMS, select **Instructor**, then select **Cohorts**. + +#. Select **Enable Cohorts**. + +You can now :ref:`add cohorts` to your course. + +.. warning:: Be very careful in deciding to enable the cohort feature in a live + course, because doing so affects the course experience for learners. + Learners might no longer have access to course and discussion topics + that were previously visible to them. + + If you must make changes to cohort configuration while your course is + running, be sure you understand the consequences of doing so. For details, + see :ref:`Altering Cohort Configuration`. + +.. seealso:: + :class: dropdown + + :ref:`Cohorts Overview` (concept) + + :ref:`Create Cohort Specific Course Content` (how-to) + + :ref:`About Divided Discussions` (concept) + + :ref:`Managing Divided Discussion Topics` (concept) + + :ref:`Moderating_discussions` (concept) + + :ref:`Setting Up Divided Discussions` (how-to) + + :ref:`Manage Course Cohorts` (how-to) + + :ref:`Enable Cohorts` (how-to) + + :ref:`Add Cohorts` (how-to) + + :ref:`Assign Learners to Cohorts Manually` (how-to) + + :ref:`Assign Learners to Cohort Groups by uploading CSV` (how-to) + + :ref:`Changing Student Cohort Assignments` (how-to) + + :ref:`Renaming a Cohort` (how-to) + + :ref:`Changing the Assignment Method of a Cohort` (how-to) + + :ref:`Disabling the Cohort Feature` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/advanced_features/managing_cohorts.rst b/source/educators/how-tos/advanced_features/managing_cohorts.rst index d214eec87..4391c597c 100644 --- a/source/educators/how-tos/advanced_features/managing_cohorts.rst +++ b/source/educators/how-tos/advanced_features/managing_cohorts.rst @@ -1,21 +1,10 @@ .. _Manage Course Cohorts: -############################################ Manage Course Cohorts -############################################ +####################### .. tags:: educator, how-to -This section provides information about setting up cohorts in your course. - -.. contents:: - :local: - :depth: 1 - -********* -Overview -********* - To use cohorts in your course, you must select a strategy for assigning your learners to cohorts: automated assignment, manual assignment, or a hybrid approach. For more information, see :ref:`Options for Assigning Learners to @@ -25,6 +14,10 @@ Cohorts`. time, you should have a strategy in mind as you design your course, and only make changes to cohorts while the course is running if absolutely necessary. +.. contents:: + :local: + :depth: 1 + You must also decide whether course-wide and content-specific discussion topics should be divided by cohort or unified for all learners. @@ -137,324 +130,6 @@ For a scenario using a manual assignment strategy, see :ref:`All Manual Assignment`. For a scenario using a combination of automated and manual assignment to cohorts, see :ref:`Hybrid Assignment`. -.. _Enable Cohorts: - -********************************* -Enabling Cohorts in your Course -********************************* - -To enable cohorts in your course, follow these steps. - -#. In the LMS, select **Instructor**, then select **Cohorts**. - -#. Select **Enable Cohorts**. - -You can now :ref:`add cohorts` to your course. - -.. warning:: Be very careful in deciding to enable the cohort feature in a live - course, because doing so affects the course experience for learners. - Learners might no longer have access to course and discussion topics - that were previously visible to them. - - If you must make changes to cohort configuration while your course is - running, be sure you understand the consequences of doing so. For details, - see :ref:`Altering Cohort Configuration`. - -.. _Add Cohorts: - -**************** -Adding Cohorts -**************** - -After you enable the cohorts feature for your course, you can add cohorts. To -add a cohort to your course, follow these steps. - -#. In the LMS, select **Instructor**, then select **Cohorts**. - -#. Click **Add Cohort**. - -#. Enter a name for the cohort. - - .. note:: - Learners can see the name of the cohort they are assigned to. The message - "This post is visible only to {cohort name}" appears with each post in - discussion topics that are divided by cohort. See :ref:`Read the Group - Indicator in Posts`. - -#. Specify whether learners are automatically or manually assigned to this - cohort. - -#. Optionally, select **Select a Content Group** to associate the cohort with a - :ref:`content group`. For information about creating - cohort-specific course content by associating cohorts with content groups, - see :ref:`Cohorted Courseware Overview`. - -#. Select **Save**. - -Continue implementing your cohort strategy by creating additional cohorts as -applicable, and specifying the assignment method for each cohort. - -.. note:: By the time your course starts, you must have at least one cohort in - your course that is automatically assigned. If you have not created at - least one automated assignment cohort in the course by the time that the - first learner accesses your course content or a divided discussion topic, - edX creates a default cohort to which learners are automatically assigned. - -For details about adding learners to a cohort by uploading a .csv file, see -:ref:`Assign Learners to Cohort Groups by uploading CSV`. - -For a report that includes the cohort assignment for every enrolled -learner, review the learner profile information for your course. See -:ref:`View and download student data`. - -.. note:: You cannot delete cohorts, but you can change their names or the way - in which learners are assigned to them. If you need to make changes to the - way you have configured cohorts while your course is running, see - :ref:`Altering Cohort Configuration`. - -.. _Assign Learners to Cohorts Manually: - -*********************************** -Assign Learners to Cohorts Manually -*********************************** - -If you have implemented a manual assignment strategy for cohorts in your -course, make sure your manual assignments are as complete as possible before -your course starts. If learners enroll after your course starts, you should -assign new learners to cohorts as soon as possible. - -.. note:: Making changes to cohort assignments after the course starts can - affect the course experience for learners. Learners might no longer have - access to course and discussion topics that were previously visible to - them. For more information, see :ref:`Altering Cohort Configuration`. - -To manually assign learners to cohorts in your course, follow these steps. - -#. View the live version of your course. For example, in Studio click **View - Live**. - -#. Select **Instructor**, then select **Cohorts**. - -#. Scroll to the **Cohort Management** section at the bottom. - -#. From the **Select a cohort** list, select the cohort to which you want to - manually assign learners. - -#. On the **Manage Learners** tab, under **Add learners to this cohort** enter - the username or email address of a single learner, or enter multiple - usernames or addresses separated by commas or new lines. You can copy data - from a .csv file of email addresses or usernames, and paste it into this - field. - - .. note:: It is not a requirement that learners have enrolled in your - course or registered on edx.org for you to manually add them to a - cohort. For learners who have not yet created an edx.org account, you - must provide a valid email address. For learners who have an edx.org - account but have not yet enrolled in your course, you can provide either - a valid email address or a recognized edx.org username. - -#. Select **Add Learners**. - - Learners you added who have edX accounts are assigned to the selected - cohorts. A confirmation message indicates the number of learners who were - successfully added to the cohort. - - Learners you added who do not yet have edX accounts are listed as - "Preassigned" to the cohort. When preassigned learners enroll in the - course, they are automatically added to the cohort. - - If some learners that you listed could not be added to cohorts, an error - message lists the email addresses or usernames of learners who could not be - added to the cohort. - -.. note:: Because learners can belong to only one cohort, adding a learner to a - cohort moves them from any cohort they were previously assigned to. The - confirmation message indicates the number of learners who were moved from - their previous cohort assignment as a result of your adding them to the - current cohort. - -For a report that includes cohort assignments for your course, review the -learner profile information for your course. See :ref:`View and download -student data`. - - -.. _Assign Learners to Cohort Groups by uploading CSV: - -*************************************************** -Assign Learners to Cohorts by Uploading a .csv File -*************************************************** - -Uploading a .csv file containing a list of learners and the cohorts that you -want to assign them to is another way of assigning learners to cohorts -manually. For details about the other manual assignment method, see -:ref:`Assign Learners to Cohorts Manually`. - - - -Any assignments to cohorts that you specify in the .csv files you upload will -overwrite or change existing cohort assignments. The configuration of your -cohorts should be complete and stable before your course begins. You should -complete manual cohort assignments as soon as possible after any learner -enrolls, especially for enrollments that occur after your course has started. -To understand the effects of changing cohort assignments after your course has -started, see :ref:`Altering Cohort Configuration`. - -.. note:: Be aware that the contents of the .csv file are processed row by - row, from top to bottom, and each row is treated independently. If the same - learner is assigned to different cohorts in different rows in the - spreadsheet, the last assignment to be performed is that learner's final - assignment. - - For example, if in your .csv file Learner A is first assigned to Cohort 1, - then later in the spreadsheet is assigned to Cohort 2, the end result of - your .csv upload is that Learner A is assigned to Cohort 2. However, the - upload results file will include Learner A twice in the "Learners Added" - count: once when they are added to Cohort 1, and again when they are added - to Cohort 2. Before submitting a file for upload, check it carefully for - duplicated learners and other errors. - - If the same learner is assigned to a cohort that they already belong to, - they are not included in the count of "Learners Added". - - -The requirements for the .csv file are summarized in this table. - -.. list-table:: - :widths: 15 30 - - * - **Requirement** - - **Notes** - * - Valid .csv file - - - The file must be a properly formatted comma-separated values file: - - * The file extension is .csv. - * Every row must have the same number of commas, whether or not there - are values in each cell. - - * - File size - - The file size of .csv files for upload is limited to a maximum of 2MB. - - * - UTF-8 encoded - - You must save the file with UTF-8 encoding so that Unicode characters - display correctly. - - See :ref:`Creating a Unicode Encoded CSV File`. - - * - Header row - - You must include a header row, with column names that exactly match - those specified in "Columns" below. - - * - One or two columns identifying learners - - You must include at least one column identifying learners: - either "email" or "username", or both. - - To preassign learners who do not yet have edX accounts, you must - provide their email addresses in an "email" column. - - If both the username and an email address are provided for a learner, - the email address has precedence. In other words, if an email address - is present, an incorrect or unrecognized username is ignored. - - * - One column identifying the cohort - - You must include one column named "cohort" to identify the cohort - to which you are assigning each learner. - - The specified cohorts must already exist in Studio. - - * - - - Columns with headings other than "email", "username" and "cohort" are - ignored. - - -To manually add learners to cohorts by uploading a .csv file, follow these -steps. - -.. note:: To add learners who do not yet have edX accounts to cohorts using a - .csv file upload, you must provide their email addresses in a column with - the heading "email". Learners without edX accounts are "preassigned" to - cohorts; they are not included in the count of learners "added" to cohorts. - -#. View the live version of your course. For example, in Studio, select **View - Live**. - -#. Select **Instructor**, then select **Cohorts**. - -#. From the **Select a cohort** list, select the cohort to which you are adding - students. - -#. Select **Assign students to cohorts by uploading a CSV file**, then select - **Browse** to navigate to the .csv file you want to upload. - -#. Select **Upload File and Assign Students**. A status message is displayed - above the **Browse** button. - -#. Verify your upload results on the **Data Download** page. - - Under **Reports Available for Download**, locate the link to a .csv file - with "cohort_results" and the date and time of your upload in the filename. - The list of available reports is sorted chronologically, with the most - recently generated files at the top. - -The results file provides the following information: - -.. list-table:: - :widths: 15 30 - - * - **Column** - - **Description** - - * - Cohort - - The name of the cohort to which you are assigning learners. - - * - Exists - - Whether the cohort was found in the system. TRUE/FALSE. - - If the cohort was not found (value is FALSE), no action is taken for - learners who you assigned to that cohort in the .csv file. - - * - Learners Added - - The number of learners added to the cohort during the row by row - processing of the .csv file. This number does not include learners who - are not enrolled in the course. - - * - Learners Not Found - - A list of the usernames of learners that could not be matched and who - were therefore not added to the cohort. - - * - Invalid Email Addresses - - A list of email addresses that were not valid. These learners could - not be added to the cohort. - - * - Preassigned Learners - - The email addresses of learners who do not yet have an edX account but - who you have preassigned to a cohort using their email addresses. - These learners are not included in the count of "Learners Added". When - these preassigned learners create an edX account and enroll in your - course, they are automatically added to the cohorts that you - preassigned them to. - - -For a report that includes the cohort assignment for every enrolled learner, -review the learner profile information for your course. See :ref:`View and -download student data`. - - -.. _Creating a Unicode Encoded CSV File: - -==================================== -Creating a Unicode-encoded .csv File -==================================== - -Make sure the .csv files that you upload are encoded as UTF-8, so that any -Unicode characters are correctly saved and displayed. - -.. note:: Some spreadsheet applications (for example, MS Excel) do not allow - you to specify encoding when you save a spreadsheet as a .csv file. To - ensure that you are able to create a .csv file that is UTF-8 encoded, use a - spreadsheet application such as Google Sheets, LibreOffice, or Apache - OpenOffice. - .. _Altering Cohort Configuration: ************************************************* @@ -476,151 +151,28 @@ consequences of these actions. * :ref:`Changing the Assignment Method of a Cohort` * :ref:`Disabling the Cohort Feature` -.. _Changing Student Cohort Assignments: - -*************************************************** -Change Learner Cohort Assignments -*************************************************** - -After your course starts and learners begin to contribute to the course -discussion, each post that they add is visible either to everyone or to the -members of a single cohort. When you change the cohort that a learner is -assigned to, there are three results. - -* The learner continues to see the posts that are visible to everyone. - -* The learner sees the posts that are visible to his new cohort. - -* The learner no longer sees the posts that are visible only to his original - cohort. - -The visibility of a post and its responses and comments does not change, even -if the cohort assignment of its author changes. To a learner, it can seem that -posts have "disappeared". - -To verify the cohort assignments for your learners, download the :ref:`student -profile report` for your course. If changes are -needed, you can :ref:`assign learners` to -different cohorts manually in the LMS by selecting **Instructor** and then -**Cohorts**, or :ref:`upload cohort assignment changes` in a .csv file. - -.. _Renaming a Cohort: - -*************** -Rename a Cohort -*************** - -You can change the name of any cohort, including the system-created default -cohort. - -To rename a cohort, follow these steps. - -#. View the live version of your course. For example, in Studio select **View - Live**. - -#. Select **Instructor**, then select **Cohorts**. - -#. From the **Select a cohort** list, select the cohort whose name you want to - change. - -#. On the **Settings** tab, in the **Cohort Name** field, enter a new name for - the cohort. - -#. Select **Save**. The name for the cohort is updated throughout the LMS and - the course, including learner-visible views. - -.. _Deleting a Cohort: - -================ -Delete a Cohort -================ - -You cannot delete cohorts. However, you can :ref:`rename a cohort`, :ref:`change its assignment method`, or move learners to other cohorts. - -If you decide that you must alter cohort configuration after your course starts -and learners begin viewing the course and the discussion topics, be sure that -you understand the consequences of these actions. For more details, see -:ref:`Altering Cohort Configuration`. - -.. _Changing the Assignment Method of a Cohort: - -****************************************** -Changing the Assignment Method of a Cohort -****************************************** - -Although you can change the assignment method of a cohort at any time after you -create it, you should have a strategy in mind as you design your course, and -only make changes to cohorts while the course is running if absolutely -necessary. Be aware of the implications of changing cohort configuration while -your course is running. For more information, see :ref:`Options for Assigning -Learners to Cohorts` and :ref:`Altering Cohort Configuration`. - -.. note:: When your course starts, you must have at least one cohort in your - course that has automatic assignment. If you have not created at least one - automated assignment cohort in the course by the time that the first learner - accesses your course content, edX creates a default cohort to which learners - are automatically assigned. If the :ref:`default group` is the only automated assignment cohort in your course, you cannot - change its assignment method to **Manual**. - -To change the assignment method of a cohort, follow these steps. - -#. View the live version of your course. For example, in Studio select **View - Live**. - -#. Select **Instructor**, then select **Cohorts**. - -#. From the **Select a cohort** list, select the cohort whose assignment method - you want to change. - -#. On the **Settings** tab, the current assignment method is selected. Change - the assignment method by selecting the other option, either **Automatic** or - **Manual**. - -#. Select **Save**. - - The cohort assignment method is updated. - -.. note:: Changing the cohort assignment method has no effect on learners who - are already assigned to this and other cohorts. Learners who access the - course after you make this change are assigned to cohorts based on the new - assignment method of this cohort combined with the assignment methods of all - other cohorts. - -.. _Disabling the Cohort Feature: - -****************************** -Disable Cohorts in Your Course -****************************** - -.. warning:: Be very careful in deciding to disable the cohort feature if you - previously had it enabled in a live course, because doing so affects the - course experience for learners. Course materials and discussion posts that - were shared only with members of particular cohorts are now visible to all - learners in the course. - - If you must make changes to the way you have configured cohorts while your - course is running, be sure you understand the consequences of doing so. For - details, see :ref:`Altering Cohort Configuration`. - -To disable cohorts in your course, follow these steps. - -#. In the LMS, select **Instructor**, then select **Cohorts**. - -#. Clear the **Enable Cohorts** option. - -All course content and discussion posts that were previously divided by cohort -immediately become visible to all students. - .. seealso:: :class: dropdown :ref:`Cohorts Overview` (concept) + :ref:`Enable Cohorts` (how-to) + + :ref:`Add Cohorts` (how-to) + + :ref:`Assign Learners to Cohorts Manually` (how-to) + + :ref:`Assign Learners to Cohort Groups by uploading CSV` (how-to) + + :ref:`Changing Student Cohort Assignments` (how-to) + + :ref:`Renaming a Cohort` (how-to) + + :ref:`Changing the Assignment Method of a Cohort` (how-to) + + :ref:`Disabling the Cohort Feature` (how-to) + :ref:`Create Cohort Specific Course Content` (how-to) :ref:`About Divided Discussions` (concept) diff --git a/source/educators/how-tos/advanced_features/rename_cohort.rst b/source/educators/how-tos/advanced_features/rename_cohort.rst new file mode 100644 index 000000000..32644e18b --- /dev/null +++ b/source/educators/how-tos/advanced_features/rename_cohort.rst @@ -0,0 +1,57 @@ +.. _Renaming a Cohort: + +Rename a Cohort +################# + +.. tags:: educator, how-to + +You can change the name of any cohort, including the system-created default +cohort. + +To rename a cohort, follow these steps. + +#. View the live version of your course. For example, in Studio select **View + Live**. + +#. Select **Instructor**, then select **Cohorts**. + +#. From the **Select a cohort** list, select the cohort whose name you want to + change. + +#. On the **Settings** tab, in the **Cohort Name** field, enter a new name for + the cohort. + +#. Select **Save**. The name for the cohort is updated throughout the LMS and + the course, including learner-visible views. + + +.. seealso:: + :class: dropdown + + :ref:`Cohorts Overview` (concept) + + :ref:`Manage Course Cohorts` (how-to) + + :ref:`Enable Cohorts` (how-to) + + :ref:`Add Cohorts` (how-to) + + :ref:`Assign Learners to Cohorts Manually` (how-to) + + :ref:`Assign Learners to Cohort Groups by uploading CSV` (how-to) + + :ref:`Changing Student Cohort Assignments` (how-to) + + :ref:`Changing the Assignment Method of a Cohort` (how-to) + + :ref:`Disabling the Cohort Feature` (how-to) + + :ref:`Create Cohort Specific Course Content` (how-to) + + :ref:`About Divided Discussions` (concept) + + :ref:`Managing Divided Discussion Topics` (concept) + + :ref:`Moderating_discussions` (concept) + + :ref:`Setting Up Divided Discussions` (how-to) \ No newline at end of file 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 786503bbc..5d56f61c2 100644 --- a/source/educators/how-tos/course_development/add_course_live.rst +++ b/source/educators/how-tos/course_development/add_course_live.rst @@ -41,7 +41,7 @@ Once successfully enabled, the LTI provider will be accessible in Provider specific configuration ******************************** -At present, edX supports following video conferencing LTI provider: +At present, Open edX supports following video conferencing LTI provider: 1. Zoom 2. Big Blue button @@ -72,7 +72,7 @@ To generate LTI credentials in LTI pro app: a. Add "instructor_email" to `Email or Employee Unique ID Attribute Name` setting. - b. Add "https://learning.edx.org" to `Approved Domains` setting. + b. Add the link to your Open edX instance to the `Approved Domains` setting. To configure Zoom, navigate to Live app configurations @@ -91,8 +91,8 @@ Once successfully enabled, Zoom will be accessible in "Live" tab in course navig :alt: Screenshot of Zoom rendered in Live tab in course navigation -Big Blue Button setup -===================== +Big Blue Button Setup +====================== `Big blue button `_ can be used to create virtual classrooms for a course. @@ -136,4 +136,11 @@ accessible in *Live* tab in course navigation. .. image:: /_images/educator_how_tos/BBB_in_live_tab.png :width: 600 - :alt: Screenshot of BBB rendered in Live tab in course navigation \ No newline at end of file + :alt: Screenshot of BBB rendered in Live tab in course navigation + +.. seealso:: + :class:dropdown + + :ref:`enable_lti_components` (how-to) + + :ref:`Determine Content Addresses` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/course_development/export_import_library.rst b/source/educators/how-tos/course_development/export_import_library.rst index 487ac79e3..c361ccad0 100644 --- a/source/educators/how-tos/course_development/export_import_library.rst +++ b/source/educators/how-tos/course_development/export_import_library.rst @@ -1,11 +1,14 @@ .. _Exporting and Importing a Library: -**************************************** Exporting and Importing a Legacy Library -**************************************** +########################################### .. tags:: educator, how-to +.. contents:: + :local: + :depth: 1 + .. warning:: The Legacy Libraries feature will be supported through Teak, moving to @@ -23,12 +26,10 @@ content library in Studio. import. Before you proceed, we recommend that you export the current library, so that you have a backup copy of it. - .. _Export a Library: -======================= Export a Legacy Library -======================= +************************ There are several reasons why you might want to export your library. @@ -59,9 +60,8 @@ computer. .. _Import a Library: -======================= Import a Legacy Library -======================= +************************* You might want to import a library if you developed or updated library content outside of Studio, or if you want to overwrite a problematic or outdated diff --git a/source/educators/navigation/advanced_features.rst b/source/educators/navigation/advanced_features.rst index 82ad9bbd5..4f58ffdb7 100644 --- a/source/educators/navigation/advanced_features.rst +++ b/source/educators/navigation/advanced_features.rst @@ -18,6 +18,14 @@ Offer Different Content to Different Groups (Cohorts) ../concepts/advanced_features/cohorts_overview.rst ../how-tos/advanced_features/managing_cohorts.rst ../how-tos/advanced_features/cohorted_courseware.rst + ../how-tos/advanced_features/enable_cohorts.rst + ../how-tos/advanced_features/add_cohorts.rst + ../how-tos/advanced_features/assign_learners_cohort_manually.rst + ../how-tos/advanced_features/assign_learners_cohort_csv.rst + ../how-tos/advanced_features/chage_learner_cohort_assignment.rst + ../how-tos/advanced_features/rename_cohort.rst + ../how-tos/advanced_features/change_assignment_method_cohort.rst + ../how-tos/advanced_features/disable_cohorts.rst ../concepts/advanced_features/group_configurations.rst ../how-tos/set_up_content_groups.rst ../how-tos/advanced_features/set_up_group_configuration_olx.rst diff --git a/source/educators/references/glossary.rst b/source/educators/references/glossary.rst index c565ddd36..b74033ab8 100644 --- a/source/educators/references/glossary.rst +++ b/source/educators/references/glossary.rst @@ -30,7 +30,7 @@ A **A/B test** - See :ref:`Content Experiment`. + See :ref:`Add Content Experiments to Your Course`. .. _About Page: @@ -40,12 +40,10 @@ A The course page that provides potential learners with a course summary, prerequisites, a course video and image, and important dates. -.. only:: Partners - For more information, see `pub creating and announcing a course`_. +.. _accessible label: - -**accessible label** +**Accessible Label** In a problem component, you use special formatting to identify the specific question that learners will answer by selecting options or entering text or @@ -64,7 +62,7 @@ A .. _Advanced Editor_g: -**advanced editor** +**Advanced Editor** An OLX (open learning XML) editor in a problem component that allows you to create and edit any type of problem. For more information, see @@ -81,10 +79,10 @@ A .. _Assignment Type: -**assignment type** +**Assignment Type** The category of graded student work, such as homework, exams, and exercises. - For more information, see :ref:`Grading Index`. + For more information, see :ref:`Grades`. .. _C: @@ -92,7 +90,7 @@ A C **** -**CAPA problem** +**CAPA Problem** A CAPA (computer assisted personalized approach) problem refers to any of the problem types that are implemented in the edX platform by the @@ -106,7 +104,7 @@ C .. _Certificate: -**certificate** +**Certificate** A document issued to an enrolled learner who successfully completes a course with the required passing grade. Not all edX courses offer certificates, and @@ -115,14 +113,14 @@ C For information about setting up certificates for your course, see :ref:`Setting Up Certificates`. -**chapter** +**Chapter** - See :ref:`Section`. + See :ref:`Section`. .. _Chemical Equation_g: -**chemical equation response problem** +**Chemical Equation Response Problem** A problem that allows learners to enter chemical equations as answers. For more information, see :ref:`Chemical Equation`. @@ -130,31 +128,31 @@ C .. _Circuit Schematic_g: -**circuit schematic builder problem** +**Circuit Schematic Builder Problem** A problem that allows learners to construct a schematic answer (such as an electronics circuit) on an interactive grid. For more information, see :ref:`Circuit Schematic Builder`. -**closed captions** +**Closed Captions** The spoken part of the transcript for a video file, which is overlaid on the video as it plays. To show or hide closed captions, you select the **CC** icon. You can move closed captions to different areas on the video screen by dragging and dropping them. - For more information, see `Video Player`_. + For more information, see `Additional Transcript Options`_. .. _codec_g: -**codec** +**Codec** A portmanteau of "code" and "decode". A computer program that can encode or decode a data stream. .. _Cohort: -**cohort** +**Cohort** A group of learners who participate in a class together. Learners who are in the same cohort can communicate and share experiences in private @@ -166,15 +164,15 @@ C .. _Component_g: -**component** +**Component** The part of a unit that contains your actual course content. A unit can contain one or more components. For more information, see - :ref:`Developing Course Components`. + :ref:`Components and Activities TOC`. .. _Content Experiment: -**content experiment** +**Content Experiment** You can define alternative course content to be delivered to different, randomly assigned groups of learners. Also known as A/B or split testing, @@ -183,14 +181,14 @@ C :ref:`Overview of Content Experiments`. -**content library** +**Content Library** - See :ref:`Library`. + See :ref:`Library_g`. .. _Content Specific Discussion Topic_g: -**content-specific discussion topic** +**Content-Specific Discussion Topic** A category within the course discussion that appears at a defined point in the course to encourage questions and conversations. To add a content- @@ -209,25 +207,25 @@ C .. _Course Catalog: -**course catalog** +**Course Catalog** - The page that lists all courses offered in the edX learning management + The page that lists all courses offered in the your Open edX learning management system. .. _Course Handouts: -**course handouts** +**Course Handouts** Course handouts are files you make available to learners on the **Home** page. For more information, see :ref:`Adding Course Updates and Handouts`. -**course mode** +**Course Mode** See :ref:`enrollment track`. -**course navigation pane** +**Course Navigation Pane** The navigation frame that appears at one side of the **Course** page in the LMS. The course navigation pane shows the sections in the course. When you @@ -238,7 +236,7 @@ C .. _Course Page: -**Course page** +**Course Page** The page that opens first when learners access your course. On the **Course** page, learners can view the course outline and directly access the course, @@ -253,24 +251,20 @@ C .. _Run: -**course run** +**Course Run** A version of the course that runs at a particular time. Information about a course run includes start and end dates, as well as staff and the languages the course is available in. You can create a course run when you create a course. - .. only:: Partners - - For more information, see :ref:`Planning Course Run Information`. - -**course track** +**Course Track** See :ref:`enrollment track`. .. _Courseware: -**courseware** +**Courseware** In OLX (open learning XML) and in data packages, "courseware" refers to the main content of your course, consisting mainly of lessons and assessments. @@ -281,7 +275,7 @@ C Note that the **Course** page was formerly called the **Courseware** page. -**course-wide discussion topic** +**Course-Wide Discussion Topic** Optional discussion categories that you create to guide how learners find and share information in the course discussion. Course-wide discussion @@ -301,7 +295,7 @@ C .. _Custom Response Problem: -**custom response problem** +**Custom Response Problem** A custom response problem evaluates text responses from learners using an embedded Python script. These problems are also called @@ -316,15 +310,13 @@ D .. _Data Czar_g: -**data czar** +**Data Czar** A data czar is the single representative at a partner institution who is responsible for receiving course data from edX, and transferring it securely to researchers and other interested parties after it is received. - For more information, see the `edX Research Guide`_. - -**discussion** +**Discussion** The set of topics defined to promote course-wide or unit-specific dialog. Learners use the discussion topics to communicate with each other and the @@ -333,7 +325,7 @@ D .. _Discussion Component: -**discussion component** +**Discussion Component** Discussion topics that course teams add directly to units. For example, a video component can be followed by a discussion component so that learners @@ -345,7 +337,7 @@ D For more information, see :ref:`Working with Discussion Components`. -**discussion thread list** +**Discussion Thread List** The navigation frame that appears at one side of the **Discussion** page in the LMS. The discussion thread list shows the discussion categories and @@ -356,7 +348,7 @@ D .. _Dropdown_g: -**dropdown problem** +**Dropdown Problem** A problem that asks learners to choose from a collection of answer options, presented as a drop-down list. For more information, see @@ -369,48 +361,13 @@ D E **** -.. _edX101_g: - -**edX101** - - An online course about how to create online courses. The intended audience - for `edX101`_ is faculty and university administrators. - -.. _edX Edge_g: - -**edX Edge** - - `edX Edge`_ is a less restricted site than edX.org. While only edX employees - and consortium members can create and post content on edX.org, any users with - course creator permissions for Edge can create courses with Studio on - studio.edge.edx.org, then view the courses on the learning management system - at edge.edx.org. - -.. _edX Studio: - -**edX Studio** - - The edX tool that you use to build your courses. For more information, see - :ref:`Getting Started with Studio`. - -.. _embargo: - -**embargo** - - An embargo is an official ban on trade or commercial activity with a - particular country. For example, due to U.S. federal regulations, edX cannot - offer certain courses (for example, particular advanced STEM courses) on the - edx.org website to learners in embargoed countries. Learners cannot access - restricted courses from an embargoed country. In some cases, depending on the - terms of the embargo, learners cannot access any edX courses at all. - -**enrollment mode** +**Enrollment Mode** See :ref:`enrollment track`. .. _enrollment_track_g: -**enrollment track** +**Enrollment Track** Also called **certificate type**, **course mode**, **course seat**, **course track**, **course type**, **enrollment mode**, or **seat type**. @@ -446,31 +403,27 @@ E * **honor**: This enrollment track was offered in the past and offered an honor code certificate to learners who pass the course. This track does not - require identity verification and does not require a fee. Note, however, - that as of December 2015, edx.org no longer offers honor code certificates. - For more information, see `News About edX Certificates`_. - - .. only:: Open_edX + require identity verification and does not require a fee. - * **professional (no ID)**: Like the professional enrollment track, this - track offers certificates and requires a fee. However, this track does - not require identity verification. Courses that offer the professional - (no ID) track do not offer a free enrollment track. + * **professional (no ID)**: Like the professional enrollment track, this + track offers certificates and requires a fee. However, this track does + not require identity verification. Courses that offer the professional + (no ID) track do not offer a free enrollment track. .. _Exercises: -**exercises** +**Exercises** Practice or practical problems that are interspersed in edX course content to keep learners engaged. Exercises are also an important measure of teaching effectiveness and learner comprehension. For more information, see - :ref:`Exercises and Tools Index`. + :ref:`Create Exercises`. .. _Export: -**export** +**Export** A tool in edX Studio that you use to export your course or library for backup purposes, or so that you can edit the course or library directly in @@ -485,7 +438,7 @@ E F *** -**forum** +**Forum** See :ref:`Discussion`. @@ -505,7 +458,7 @@ G .. _grade: -**grade range** +**Grade Range** Thresholds that specify how numerical scores are associated with grades, and the score that learners must obtain to pass a course. @@ -513,7 +466,7 @@ G For more information, see :ref:`Set the Grade Range`. -**grading rubric** +**Grading Rubric** See :ref:`Rubric`. @@ -538,7 +491,7 @@ H .. _Text Component: -**Text component** +**Text Component** A type of component that you can use to add and format text for your course. A Text component can contain text, lists, links, and images. For more @@ -555,7 +508,7 @@ I .. _Image Mapped_g: -**Image mapped input problem** +**Image Mapped Input Problem** A problem that presents an image and accepts clicks on the image as an answer. For more information, see :ref:`Image Mapped @@ -574,15 +527,14 @@ I For more information, see :ref:`Import a Course` or :ref:`Import a Library`. -**instructor dashboard** +**Instructor Dashboard** A user who has the Admin or Staff role for a course can access the instructor dashboard in the LMS by selecting **Instructor**. Course team members use the tools, reports, and other features that are available on the pages of the instructor dashboard to manage a running course. - For more information, see :ref:`Managing Live Course - Index`. + For more information, see :ref:`Content Creation and Management TOC`. .. _K: @@ -590,7 +542,7 @@ I K **** -**keyword** +**Keyword** A variable in a bulk email message. When you send the message, a value that is specific to the each recipient is substituted for the keyword. @@ -601,7 +553,7 @@ K L **** -**label** +**Label** See :ref:`Accessible Label`. @@ -615,23 +567,23 @@ L .. _Learning Management System: -**learning management system (LMS)** +**Learning Management System (LMS)** The platform that learners use to view courses, and that course team members use to manage learner enrollment, assign team member privileges, moderate discussions, and access data while the course is running. -**learning sequence** +**Learning Sequence** See :ref:`Unit Navigation Bar`. -**left pane** +**Left Pane** See :ref:`Course Navigation Pane`. .. _Library_g: -**library** +**Library** A pool of components for use in randomized assignments that can be shared across multiple courses from your organization. Course teams configure @@ -639,13 +591,13 @@ L of components, and randomly provide a specified number of problems from that content library to each learner. - For more information, see :ref:`Content Libraries` and + For more information, see :ref:`Navigate the Library Homepage` and :ref:`Randomized Content Blocks`. .. _Live Mode: -**live mode** +**Live Mode** A view that allows the course team to review all published units as learners see them, regardless of the release dates of the section and subsection that @@ -669,13 +621,12 @@ M .. _Math Expression_g: -**math expression input problem** +**Math Expression Input Problem** A problem that requires learners to enter a mathematical expression as text, such as e=m*c^2. - For more information, see `Math Formatting`_ in the *EdX - Learner's Guide*. + For more information, see `Adding Math Expression Problem`_. .. _MathJax: @@ -690,7 +641,7 @@ M .. _Module_g: -**module** +**Module** An item of course content, created in an XBlock, that appears on the **Course** page in the edX learning management system. Examples of @@ -704,11 +655,11 @@ M .. _Multi-select_g: -**multi-select problem** +**Multi-Select Problem** A problem that prompts learners to select one or more options from a list of possible answers. For more information, see - :ref:`Multi-select`. + :ref:`Multi select`. .. _N: @@ -726,7 +677,7 @@ N .. _Numerical Input_g: -**numerical input problem** +**numerical Input Problem** A problem that asks learners to enter numbers or specific and relatively simple mathematical expressions. For more information, see @@ -744,12 +695,12 @@ O OLX (open learning XML) is the XML-based markup language that is used to build courses on the Open edX platform. - For more information, see `What is Open Learning XML? `_. + For more information, see :ref:`Add a Content Experiment in OLX`. .. _Open Response Assessment_g: -**open response assessment** +**Open Response Assessment** A type of assignment that allows learners to answer with text, such as a short essay and, optionally, an image or other file. Learners then evaluate @@ -760,8 +711,7 @@ O compare their own responses to the rubric, or a staff assessment, in which members of course staff evaluate learner responses using the same rubric. - For more information, see :ref:`Open Response Assessments - Two`. + For more information, see :ref:`Open Response Assessments`. .. _P: @@ -771,7 +721,7 @@ P .. _Pages_g: -**pages** +**Pages** Pages organize course materials into categories that learners select in the learning management system. Pages provide access to the course content and to @@ -789,15 +739,9 @@ P analog videos. It is used in locations such as Brazil, Australia, south Asia, most of Africa, and western Europe. -**partner manager** - - Each EdX partner institution has an edX partner manager. The partner manager - is the primary contact for the institution's course teams. - - .. _Preview Mode: -**preview mode** +**Preview Mode** A view that allows you to see all the units of your course as learners see them, regardless of the unit status and regardless of whether the release @@ -809,18 +753,18 @@ P .. _Problem Component: -**problem component** +**Problem Component** A component that allows you to add interactive, automatically graded exercises to your course content. You can create many different types of problems. For more information, see :ref:`Working with Problem - Components` and :ref:`Exercises and Tools Index`. + Components` and :ref:`Core Problem Types`. .. _Proctored Exam_g: -**proctored exam** +**Proctored Exam** At edX, proctored exams are timed, impartially and electronically monitored exams designed to ensure the identity of the test taker and determine the @@ -830,20 +774,16 @@ P .. _Program: -**program** +**Program** A program is a collection of related courses. Learners enroll in a program by enrolling in any course that is part of a program, and earn a program certificate by passing each of the courses in the program with a grade that qualifies them for a verified certificate. - Several types of program are available on edx.org, including MicroMasters, - Professional Certificate, and XSeries programs. - - .. _Program Offer: -**program offer** +**Program Offer** A program offer is a discount offered for a specific program. The discount can be either a percentage amount or an absolute (dollar) amount. @@ -854,8 +794,7 @@ P **Progress page** The page in the learning management system that shows learners their scores - on graded assignments in the course. For more information, see - `SFD Check Progress`_ in the *EdX Learner's Guide*. + on graded assignments in the course. .. _Q: @@ -864,7 +803,7 @@ P Q ***** -**question** +**Question** A question is a type of post that you or a learner can add to a course discussion topic to bring attention to an issue that the discussion @@ -892,14 +831,14 @@ R .. _Rubric_g: -**rubric** +**Rubric** A list of the items that a learner's response should cover in an open response assessment. For more information, see the :ref:`PA Rubric` topic in :ref:`Open - Response Assessments Two`. + Response Assessments`. - See also :ref:`Open Response Assessment`. + See also :ref:`Open Response Assessment_g`. .. _S: @@ -908,13 +847,13 @@ R S **** -**seat type** +**Seat Type** See :ref:`enrollment track`. .. _Section_g: -**section** +**Section** The topmost category in your course outline. A section can represent a time period or another organizing principle for course content. A section @@ -924,30 +863,29 @@ S Sections`. -**sequential** +**Sequential** See :ref:`Subsection`. .. _Short Course Description: -**short description** +**Short Description** - The description of your course that appears on the edX `Course List - `_ page. + The description of your course that appears on Course Dashboard of your instance. For more information, see :ref:`Course Short Description Guidelines`. .. _Simple Editor_g: -**simple editor** +**Simple Editor** The graphical user interface in a problem component. The simple editor is available for some problem types. For more information, see :ref:`Problem Studio View`. -**single sign-on (SSO)** +**Single Sign-On (SSO)** SSO is an authentication service that allows a user to access multiple related applications, such as Studio and the LMS, with the same username and @@ -959,7 +897,7 @@ S .. _Single_select_g: -**single select problem** +**Single Select Problem** A problem that asks learners to select one answer from a list of options. For more information, see :ref:`Single Select`. @@ -967,21 +905,21 @@ S .. _Special Exam_g: -**special exam** +**Special Exam** A general term that applies to proctored and timed exams in edX courses. See :ref:`Timed Exam` and :ref:`Proctored Exam

`. .. _Split_Test: -**split test** +**Split Test** See :ref:`Content Experiment`. .. _Subsection: -**subsection** +**Subsection** A division in the course outline that represents a topic in your course, such as a lesson or another organizing principle. Subsections are defined @@ -999,7 +937,7 @@ T .. _Text Input_g: -**text input problem** +**Text Input Problem** A problem that asks learners to enter a line of text, which is then checked against a specified expected answer. @@ -1008,7 +946,7 @@ T .. _Timed Exam_g: -**timed exam** +**Timed Exam** Timed exams are sets of problems that a learner must complete in the amount of time you specify. When a learner begins a timed exam, a countdown timer @@ -1018,7 +956,7 @@ T .. _TPA_g: -**third party authentication** +**Third-Party Authentication** A system-wide configuration option that allows users who have a username and password for one system, such as a campus or institutional system, to log in @@ -1027,16 +965,16 @@ T For more information about how system administrators can integrate an instance of Open edX with a campus or institutional authentication system, - see :ref:`Enabling Third Party Authentication`. + see :ref:`enable_lti_components`. .. _Transcript Definition: -**transcript** +**Transcript** A text version of the content of a video. You can make video transcripts available to learners. - For more information, see :ref:`Obtain a Video Transcript`. + For more information, see :ref:`Additional Transcript Options`. .. _U: @@ -1044,14 +982,14 @@ T U *** -**unit** +**Unit** A unit is a division in the course outline that represents a lesson. Learners view all of the content in a unit on a single page. For more information, see :ref:`Developing Course Units`. -**unit navigation bar** +**Unit Navigation Bar** The horizontal control that appears at the top of the **Course** page in the LMS. The unit navigation bar contains an icon for each unit in the selected @@ -1075,13 +1013,13 @@ V processed or transferred. A variable bit rate allows the bit rate to change according to the complexity of the media segment. -**vertical** +**Vertical** See :ref:`Unit`. .. _Video Component: -**video component** +**Video Component** A component that you can use to add recorded videos to your course. @@ -1097,7 +1035,7 @@ W .. _Whitelist: -**whitelist** +**Whitelist** In edX courses, a whitelist is a list of learners who are being provided with a particular privilege. For example, whitelisted learners can be specified as @@ -1112,12 +1050,12 @@ W .. _Wiki: -**wiki** +**Wiki** The page in each edX course that allows both learners and members of the course team to add, modify, or delete content. Learners can use the wiki to share links, notes, and other helpful information with each other. For more - information, see :ref:`Course_Wiki`. + information, see :ref:`About Course Wiki`. .. _X: @@ -1134,14 +1072,5 @@ XYZ the components that deliver course content to learners. Third parties can create components as web applications that can run within - the edX learning management system. For more information, see - :ref:`Open edX XBlock Tutorial`. - - -**XSeries** - - A set of related courses in a specific subject. Learners qualify for an - XSeries certificate when they pass all of the courses in the XSeries. For - more information, see `XSeries Programs`_. - + the edX learning management system. From a84e725585eff91d23b1cd8b9f7ceeda59b71ee9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Mon, 30 Dec 2024 16:49:26 -0500 Subject: [PATCH 2/3] Update glossary.rst --- source/educators/references/glossary.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/educators/references/glossary.rst b/source/educators/references/glossary.rst index b74033ab8..9353377ba 100644 --- a/source/educators/references/glossary.rst +++ b/source/educators/references/glossary.rst @@ -115,7 +115,7 @@ C **Chapter** - See :ref:`Section`. + See :ref:`Section_g`. .. _Chemical Equation_g: @@ -141,7 +141,7 @@ C icon. You can move closed captions to different areas on the video screen by dragging and dropping them. - For more information, see `Additional Transcript Options`_. + For more information, see :ref:`Additional Transcript Options`. .. _codec_g: @@ -626,7 +626,7 @@ M A problem that requires learners to enter a mathematical expression as text, such as e=m*c^2. - For more information, see `Adding Math Expression Problem`_. + For more information, see :ref:`Adding Math Expression Problem`. .. _MathJax: From 6bb1775ae1a0ec4c0989864b4606a853d73f702c Mon Sep 17 00:00:00 2001 From: Sarina Canelake Date: Mon, 6 Jan 2025 08:16:57 -0500 Subject: [PATCH 3/3] Apply suggestions from code review --- source/educators/how-tos/advanced_features/add_cohorts.rst | 2 +- .../advanced_features/assign_learners_cohort_csv.rst | 2 +- .../advanced_features/chage_learner_cohort_assignment.rst | 6 +++--- .../advanced_features/change_assignment_method_cohort.rst | 4 ++-- .../how-tos/course_development/add_course_live.rst | 6 +++--- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/source/educators/how-tos/advanced_features/add_cohorts.rst b/source/educators/how-tos/advanced_features/add_cohorts.rst index 5feb6a526..eefe58669 100644 --- a/source/educators/how-tos/advanced_features/add_cohorts.rst +++ b/source/educators/how-tos/advanced_features/add_cohorts.rst @@ -37,7 +37,7 @@ applicable, and specifying the assignment method for each cohort. your course that is automatically assigned. If you have not created at least one automated assignment cohort in the course by the time that the first learner accesses your course content or a divided discussion topic, - Open edX creates a default cohort to which learners are automatically assigned. + the platform creates a default cohort in your course to which learners are automatically assigned. For details about adding learners to a cohort by uploading a .csv file, see :ref:`Assign Learners to Cohort Groups by uploading CSV`. diff --git a/source/educators/how-tos/advanced_features/assign_learners_cohort_csv.rst b/source/educators/how-tos/advanced_features/assign_learners_cohort_csv.rst index 8ab3e6bd7..6df6bc70c 100644 --- a/source/educators/how-tos/advanced_features/assign_learners_cohort_csv.rst +++ b/source/educators/how-tos/advanced_features/assign_learners_cohort_csv.rst @@ -8,7 +8,7 @@ Assign Learners to Cohorts by Uploading a .csv File Uploading a .csv file containing a list of learners and the cohorts that you want to assign them to is another way of assigning learners to cohorts manually. For details about the other manual assignment method, see -:ref:`Assign Learners to Cohorts Manually`.¿ +:ref:`Assign Learners to Cohorts Manually`. Any assignments to cohorts that you specify in the .csv files you upload will overwrite or change existing cohort assignments. The configuration of your diff --git a/source/educators/how-tos/advanced_features/chage_learner_cohort_assignment.rst b/source/educators/how-tos/advanced_features/chage_learner_cohort_assignment.rst index 5680eb209..c8650dd28 100644 --- a/source/educators/how-tos/advanced_features/chage_learner_cohort_assignment.rst +++ b/source/educators/how-tos/advanced_features/chage_learner_cohort_assignment.rst @@ -8,13 +8,13 @@ Change Learner Cohort Assignments After your course starts and learners begin to contribute to the course discussion, each post that they add is visible either to everyone or to the members of a single cohort. When you change the cohort that a learner is -assigned to, there are three results. +assigned to, the following occur: * The learner continues to see the posts that are visible to everyone. -* The learner sees the posts that are visible to his new cohort. +* The learner now sees the posts that are visible to their new cohort. -* The learner no longer sees the posts that are visible only to his original +* The learner no longer sees the posts that are visible only to their original cohort. The visibility of a post and its responses and comments does not change, even diff --git a/source/educators/how-tos/advanced_features/change_assignment_method_cohort.rst b/source/educators/how-tos/advanced_features/change_assignment_method_cohort.rst index a09df0f26..76401061d 100644 --- a/source/educators/how-tos/advanced_features/change_assignment_method_cohort.rst +++ b/source/educators/how-tos/advanced_features/change_assignment_method_cohort.rst @@ -15,8 +15,8 @@ Learners to Cohorts` and :ref:`Altering Cohort Configuration`. .. note:: When your course starts, you must have at least one cohort in your course that has automatic assignment. If you have not created at least one automated assignment cohort in the course by the time that the first learner - accesses your course content, Open edX creates a default cohort to which learners - are automatically assigned. If the :ref:`default group` is the only automated assignment cohort in your course, you cannot change its assignment method to **Manual**. 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 5d56f61c2..da473fe6d 100644 --- a/source/educators/how-tos/course_development/add_course_live.rst +++ b/source/educators/how-tos/course_development/add_course_live.rst @@ -41,7 +41,7 @@ Once successfully enabled, the LTI provider will be accessible in Provider specific configuration ******************************** -At present, Open edX supports following video conferencing LTI provider: +At present, the Open edX platform supports following video conferencing LTI provider: 1. Zoom 2. Big Blue button @@ -72,7 +72,7 @@ To generate LTI credentials in LTI pro app: a. Add "instructor_email" to `Email or Employee Unique ID Attribute Name` setting. - b. Add the link to your Open edX instance to the `Approved Domains` 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 @@ -91,7 +91,7 @@ Once successfully enabled, Zoom will be accessible in "Live" tab in course navig :alt: Screenshot of Zoom rendered in Live tab in course navigation -Big Blue Button Setup +Big Blue Button setup ====================== `Big blue button `_ can be used to create virtual classrooms