From c26b4a0e85843166f16540eeb5df21b20d05bb9f Mon Sep 17 00:00:00 2001 From: John Swope Date: Wed, 8 Jan 2025 18:04:50 -0500 Subject: [PATCH 1/6] Remove the intersphinx_mapping to legacy docs --- source/conf.py | 8 -------- 1 file changed, 8 deletions(-) diff --git a/source/conf.py b/source/conf.py index 093defc60..1d53051e3 100644 --- a/source/conf.py +++ b/source/conf.py @@ -104,14 +104,6 @@ "event-routing-backends": ( f"https://event-routing-backends.readthedocs.io/{rtd_language}/{rtd_version}", None ), - "edx-installing-configuring-and-running": ( - f"https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/{rtd_language}/{rtd_version}", - None, - ), - "openedx-building-and-running-a-course": ( - f"https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/{rtd_language}/{rtd_version}", - None, - ), "edx-platform": ( f"https://docs.openedx.org/projects/edx-platform/{rtd_language}/{rtd_version}", None, From 6a57c72491f5943ba791458e92c623086b29b5b9 Mon Sep 17 00:00:00 2001 From: John Swope Date: Wed, 8 Jan 2025 19:07:30 -0500 Subject: [PATCH 2/6] Change breaking references to external docs to internal --- .../developer_guide/extending_platform/extending.rst | 6 +++--- .../developer_guide/extending_platform/xblocks.rst | 2 +- .../educators/concepts/accessibility/design_for_mobile.rst | 3 +-- .../concepts/advanced_features/lti_reuse_content.rst | 4 ++-- .../advanced_features/offering_differentiated_content.rst | 4 +--- .../advanced_features/teams_learner_experience.rst | 2 +- .../advanced_features/using_openedx_as_LTI_provider.rst | 6 +++--- .../concepts/exercise_tools/OpenResponseAssessments.rst | 4 ++-- .../concepts/open_edx_platform/outline_studio_lms.rst | 3 +-- .../planning_course_run_information/set_up_course.rst | 2 +- .../proctored_exams/preparing_learners_proctored_exams.rst | 3 +-- .../concepts/proctored_exams/proctored_exams_overview.rst | 2 +- source/educators/how-tos/advanced_features/add_cohorts.rst | 2 +- .../how-tos/advanced_features/cohorted_courseware.rst | 6 +++--- .../advanced_features/create_content_experiment.rst | 2 +- .../how-tos/advanced_features/lti_blackboard_example.rst | 4 ++-- .../how-tos/advanced_features/lti_canvas_example.rst | 2 +- .../advanced_features/lti_determine_content_address.rst | 2 +- .../how-tos/advanced_features/lti_prepare_content.rst | 2 +- source/educators/how-tos/advanced_features/timed_exams.rst | 4 +++- .../how-tos/communication/configure-discussions.rst | 6 ++++-- .../communication/setting_up_divided_discussions.rst | 6 ++---- .../educators/how-tos/configure_prerequisite_content.rst | 7 +++---- .../course_development/additional_video_options.rst | 2 +- .../proctored_exams/create_proctored_exam_rpnow.rst | 2 +- .../advanced_features/planning_content_reuse.rst | 2 +- .../references/course_development/course_outline.rst | 2 +- .../references/course_development/course_units.rst | 2 +- .../course_development/text_components/text_components.rst | 2 +- .../course_development/unit_workflow_and_status.rst | 2 +- .../proctored_exams/pt_proctored_exam_report.rst | 2 +- .../proctored_exams/rpnow_proctored_exam_report.rst | 2 +- source/educators/references/workflow.rst | 2 +- 33 files changed, 50 insertions(+), 54 deletions(-) diff --git a/source/developers/references/developer_guide/extending_platform/extending.rst b/source/developers/references/developer_guide/extending_platform/extending.rst index 9d3b981e6..2295dcecc 100644 --- a/source/developers/references/developer_guide/extending_platform/extending.rst +++ b/source/developers/references/developer_guide/extending_platform/extending.rst @@ -61,7 +61,7 @@ ways to extend the platform, starting with the following table. - Yes * - Clean UI Integration - Yes - - No (see :doc:`openedx-building-and-running-a-course:exercises_tools/lti_component`) + - No (see :ref:`LTI Component`) - Yes - Yes - Yes @@ -72,13 +72,13 @@ ways to extend the platform, starting with the following table. - Yes - Yes * - Server Side Grading - - Possibly (See :doc:`openedx-building-and-running-a-course:exercises_tools/custom_javascript`) + - Possibly (See :ref:`Custom JavaScript`) - Yes - Yes - Yes - Yes * - Usage Data - - No (See :doc:`openedx-building-and-running-a-course:exercises_tools/custom_javascript`) + - No (See :doc:`Custom JavaScript`) - No - Limited - Yes diff --git a/source/developers/references/developer_guide/extending_platform/xblocks.rst b/source/developers/references/developer_guide/extending_platform/xblocks.rst index 7e5c06fd6..3901aa561 100644 --- a/source/developers/references/developer_guide/extending_platform/xblocks.rst +++ b/source/developers/references/developer_guide/extending_platform/xblocks.rst @@ -166,7 +166,7 @@ other course content component, or for sequential or vertical course container component. There are several ways to find the ``usage_id`` for an XBlock in the LMS, including viewing either the staff debug info or the page source. For more information, see -:doc:`openedx-building-and-running-a-course:course_features/lti/lti_address_content`. +:ref:`Determine Content Addresses`. Example XBlock URLs diff --git a/source/educators/concepts/accessibility/design_for_mobile.rst b/source/educators/concepts/accessibility/design_for_mobile.rst index 6c8c18b9f..49fe79fff 100644 --- a/source/educators/concepts/accessibility/design_for_mobile.rst +++ b/source/educators/concepts/accessibility/design_for_mobile.rst @@ -12,8 +12,7 @@ to everyone, regardless of any physical limitation that they might have, and regardless whether they are accessing your course using a Web browser or using mobile apps. -For information about accessibility best practices, see :ref:`Accessibility -Index `. +For information about accessibility best practices, see :ref:`Accessibility Best Practices for Course Content Development`. The percentage of learners who access MOOCs using smartphones is increasing every day. Courses on your instance may be viewed on smartphones using the diff --git a/source/educators/concepts/advanced_features/lti_reuse_content.rst b/source/educators/concepts/advanced_features/lti_reuse_content.rst index 7ad3d0ab7..b44dc982b 100644 --- a/source/educators/concepts/advanced_features/lti_reuse_content.rst +++ b/source/educators/concepts/advanced_features/lti_reuse_content.rst @@ -35,7 +35,7 @@ content in the context of an external LMS. :depth: 1 For information about the content that you can include in an external LMS, see -:ref:`Preparing Content`. +:ref:`Planning for Content Reuse`. ********************************** Course Roster Management @@ -74,7 +74,7 @@ example, edX course discussions can identify participants by their edX IDs instead of the usernames they would normally see in the external LMS. As a result, some edX content is not currently suitable for use in an external LMS. -For more information, see :ref:`Preparing Content`. +For more information, see :ref:`Planning for Content Reuse`. ****************************** Learner Progress and Grades diff --git a/source/educators/concepts/advanced_features/offering_differentiated_content.rst b/source/educators/concepts/advanced_features/offering_differentiated_content.rst index 0b8bb26ae..888edb2d9 100644 --- a/source/educators/concepts/advanced_features/offering_differentiated_content.rst +++ b/source/educators/concepts/advanced_features/offering_differentiated_content.rst @@ -41,7 +41,7 @@ If you have enabled cohorts in your course, you can associate one or more cohort For example, you might intend all learners in your course to have substantially the same course experience, except that you want to show learners who are either current students or alumni of your institution a special video in several sections. You already have your institution's current students in one cohort and alumni in another cohort. By associating both of these cohorts with the same content group, and restricting access to the special institutional-related video to only this content group, you can provide a customized course experience. -For information about creating differentiated content using cohorts, see :ref:`Cohorts Overview` and :ref:`Cohorted Courseware Overview`. +For information about creating differentiated content using cohorts, see :ref:`Cohorts Overview`. .. seealso:: @@ -49,8 +49,6 @@ For information about creating differentiated content using cohorts, see :ref:`C :ref:`Cohorts Overview` (concept) - :ref:`Cohorted Courseware Overview` (concept) - :ref:`About Content Groups` (concept) :ref:`Overview of Content Experiments` (concept) diff --git a/source/educators/concepts/advanced_features/teams_learner_experience.rst b/source/educators/concepts/advanced_features/teams_learner_experience.rst index 7c56fa9e0..793524405 100644 --- a/source/educators/concepts/advanced_features/teams_learner_experience.rst +++ b/source/educators/concepts/advanced_features/teams_learner_experience.rst @@ -7,7 +7,7 @@ The Learner's Experience of Teams .. tags:: educator, concept -After you have :ref:`enabled teams ` and created topics in your +After you have :ref:`enabled teams ` and created topics in your course, learners can begin browsing topics and joining teams. Teams are formed within topics. Each learner can belong to only one team. diff --git a/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst b/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst index e67f8660d..62ee3bd3b 100644 --- a/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst +++ b/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst @@ -51,7 +51,7 @@ requirements. a learner and not a TA or course designer. For more information about constructing an LTI URL for a course component, see -:ref:`Determining Content Addresses`. +:ref:`Determine Content Addresses`. .. seealso:: :class: dropdown @@ -62,6 +62,6 @@ For more information about constructing an LTI URL for a course component, see :ref:`Planning for Content Reuse (LTI)` (reference) - :ref:`Example: edX as an LTI Provider to Canvas` (reference) + :ref:`Example: Open edX as an LTI Provider to Canvas` (reference) - :ref:`Example: edX as an LTI Provider to Blackboard` (reference) \ No newline at end of file + :ref:`Example: edX as an LTI Provider to Blackboard` (reference) \ No newline at end of file diff --git a/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst b/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst index 19344a34c..fb9fc8900 100644 --- a/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst +++ b/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst @@ -18,7 +18,7 @@ assessment) to complete the assignment. an open response assessment divided by cohort, you must create that assessment in a course component that is defined as cohort-specific. For more information about cohorts and creating cohort-specific course content, see - :ref:`Cohorts Overview ` and :ref:`Cohorted Courseware Overview `. + :ref:`Cohorts Overview ` and :ref:`Offering Differentiated Content to Different Learner Groups `. The following topics provide conceptual information about open response assessments. @@ -374,7 +374,7 @@ steps, and make it available only to the members of one or more specific cohorts. For the members of the remaining cohorts, you create an ORA assignment that has only the peer assessment step. For details about creating different course experiences for learners in different cohorts, see -:ref:`Cohorted Courseware Overview `. +:ref:`Cohorted Courseware Overview `. For details about performing grading in staff assessment steps, see :ref:`Perform a Staff Assessment`. diff --git a/source/educators/concepts/open_edx_platform/outline_studio_lms.rst b/source/educators/concepts/open_edx_platform/outline_studio_lms.rst index 6ccda0734..77c8befbf 100644 --- a/source/educators/concepts/open_edx_platform/outline_studio_lms.rst +++ b/source/educators/concepts/open_edx_platform/outline_studio_lms.rst @@ -42,5 +42,4 @@ If a learner selects the **Resume Course** option, the course opens to the unit that the learner most recently completed. For information about more specific learner data, including the learner's -grades or answers for individual problems, see :ref:`Manage Student Progress -Index`. \ No newline at end of file +grades or answers for individual problems, see :ref:`Learner Data`. diff --git a/source/educators/concepts/planning_course_run_information/set_up_course.rst b/source/educators/concepts/planning_course_run_information/set_up_course.rst index 15ca40d4c..d0ed58cab 100644 --- a/source/educators/concepts/planning_course_run_information/set_up_course.rst +++ b/source/educators/concepts/planning_course_run_information/set_up_course.rst @@ -16,4 +16,4 @@ types of basic information about your course. information such as the course staff and start and end dates. For information about how to develop your course content in the Studio course -outline, see :ref:`Developing Your Course Index `. \ No newline at end of file +outline, see :ref:`Developing Your Course Outline`. \ No newline at end of file diff --git a/source/educators/concepts/proctored_exams/preparing_learners_proctored_exams.rst b/source/educators/concepts/proctored_exams/preparing_learners_proctored_exams.rst index 9f4076b96..d9167319f 100644 --- a/source/educators/concepts/proctored_exams/preparing_learners_proctored_exams.rst +++ b/source/educators/concepts/proctored_exams/preparing_learners_proctored_exams.rst @@ -15,8 +15,7 @@ To prepare learners for a proctored exam, follow these guidelines: * Explain what proctored exams are, and provide learners with links to the `OE SFD Proctored Exams`_ topic in the *Open edX Learner’s Guide*. -* Communicate the rules for proctored exams, including the :ref:`online - proctoring rules` in the *Open edX Learner’s +* Communicate the rules for proctored exams, including the :ref:`Online Proctoring Rules` in the *Open edX Learner’s Guide* as well as any specific rules for a particular exam. For information about creating specific rules, see :ref:`specifying_exam_rules_and_exceptions`. diff --git a/source/educators/concepts/proctored_exams/proctored_exams_overview.rst b/source/educators/concepts/proctored_exams/proctored_exams_overview.rst index c096ac032..316ac2f7c 100644 --- a/source/educators/concepts/proctored_exams/proctored_exams_overview.rst +++ b/source/educators/concepts/proctored_exams/proctored_exams_overview.rst @@ -10,7 +10,7 @@ Proctored exams are timed exams that learners take while online proctoring software monitors their computer, environment, and behavior. When learners complete a proctored exam, the recording of the exam is examined to determine whether the learner complied with the :ref:`online proctoring rules -`. +`. Learners must be in the verified enrollment track to take a proctored exam. diff --git a/source/educators/how-tos/advanced_features/add_cohorts.rst b/source/educators/how-tos/advanced_features/add_cohorts.rst index eefe58669..48d695b56 100644 --- a/source/educators/how-tos/advanced_features/add_cohorts.rst +++ b/source/educators/how-tos/advanced_features/add_cohorts.rst @@ -26,7 +26,7 @@ add a cohort to your course, follow these steps. #. 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`. + see :ref:`Cohorts Overview` and :ref:`Offering Differentiated Content`. #. Select **Save**. diff --git a/source/educators/how-tos/advanced_features/cohorted_courseware.rst b/source/educators/how-tos/advanced_features/cohorted_courseware.rst index 2bfa16d08..beec0c818 100644 --- a/source/educators/how-tos/advanced_features/cohorted_courseware.rst +++ b/source/educators/how-tos/advanced_features/cohorted_courseware.rst @@ -17,7 +17,7 @@ cohorts. Overview ********* -If you have :ref:`enabled cohorts` in your +If you have :ref:`enabled cohorts` in your course, you can create different course experiences for learners in different cohorts. @@ -36,7 +36,7 @@ Complete these steps to create cohort-specific content in your course. In Studio -#. :ref:`Enable cohorts in your course`. +#. :ref:`Enable cohorts in your course`. #. :ref:`Create content groups`. #. :ref:`Specify components or units as available only to particular content groups`. @@ -61,7 +61,7 @@ University Alumni and Current University Students. Learners who are not in either of these cohorts are automatically placed into a third cohort, the default cohort, when they access the **Course** or **Discussion** tabs in the course. For more information about enabling cohorts in your course and -assigning students to cohorts, see :ref:`Enabling and Configuring Cohorts`. +assigning students to cohorts, see :ref:`Manage Course Cohorts`. You intend all learners to have substantially the same course experience, with the exception that only learners in the two university-related cohorts will diff --git a/source/educators/how-tos/advanced_features/create_content_experiment.rst b/source/educators/how-tos/advanced_features/create_content_experiment.rst index d2f9e612a..60e6ba5a0 100644 --- a/source/educators/how-tos/advanced_features/create_content_experiment.rst +++ b/source/educators/how-tos/advanced_features/create_content_experiment.rst @@ -24,7 +24,7 @@ completed the following tasks. The content experiment includes a container for each group that is defined in the group configuration you selected. You create content for each experiment group as you do any other component. For more information, see - :ref:`Developing Course Components`. + :ref:`Add a Component`. #. Select either **Select a Group Configuration** or **Edit** to open the content experiment component. diff --git a/source/educators/how-tos/advanced_features/lti_blackboard_example.rst b/source/educators/how-tos/advanced_features/lti_blackboard_example.rst index c666ab207..3e64fbadd 100644 --- a/source/educators/how-tos/advanced_features/lti_blackboard_example.rst +++ b/source/educators/how-tos/advanced_features/lti_blackboard_example.rst @@ -35,7 +35,7 @@ To use Open edX course content in the Blackboard LMS, you add a new app to the c :alt: The Blackboard Create Web Link page with example name and URL values. - For more information, see :ref:`Determining Content Addresses`. + For more information, see :ref:`Determine Content Addresses`. #. Review the content to verify that it appears as you expect. @@ -54,4 +54,4 @@ To use Open edX course content in the Blackboard LMS, you add a new app to the c :ref:`Planning for Content Reuse (LTI)` (reference) - :ref:`Example: edX as an LTI Provider to Canvas` (reference) + :ref:`Example: Open edX as an LTI Provider to Canvas` (reference) diff --git a/source/educators/how-tos/advanced_features/lti_canvas_example.rst b/source/educators/how-tos/advanced_features/lti_canvas_example.rst index e32d50a29..52ca226ca 100644 --- a/source/educators/how-tos/advanced_features/lti_canvas_example.rst +++ b/source/educators/how-tos/advanced_features/lti_canvas_example.rst @@ -26,7 +26,7 @@ To use Open edX course content in the Canvas LMS, you add a new app to the cours :alt: The Canvas page where you add an external tool and supply the LTI URL. - For more information, see :ref:`Determining Content Addresses`. + For more information, see :ref:`Determine Content Addresses`. #. Review the content to verify that it appears as you expect. diff --git a/source/educators/how-tos/advanced_features/lti_determine_content_address.rst b/source/educators/how-tos/advanced_features/lti_determine_content_address.rst index 93134a43e..9f93051c2 100644 --- a/source/educators/how-tos/advanced_features/lti_determine_content_address.rst +++ b/source/educators/how-tos/advanced_features/lti_determine_content_address.rst @@ -238,7 +238,7 @@ LTI URLs for Text components include "html+block" or "html", as follows. :ref:`Planning for Content Reuse (LTI)` (reference) - :ref:`Example: edX as an LTI Provider to Canvas` (reference) + :ref:`Example: Open edX as an LTI Provider to Canvas` (reference) :ref:`Example: edX as an LTI Provider to Blackboard` (reference) diff --git a/source/educators/how-tos/advanced_features/lti_prepare_content.rst b/source/educators/how-tos/advanced_features/lti_prepare_content.rst index 338a63617..6649f2523 100644 --- a/source/educators/how-tos/advanced_features/lti_prepare_content.rst +++ b/source/educators/how-tos/advanced_features/lti_prepare_content.rst @@ -64,6 +64,6 @@ steps. :ref:`Planning for Content Reuse (LTI)` (reference) - :ref:`Example: edX as an LTI Provider to Canvas` (reference) + :ref:`Example: Open edX as an LTI Provider to Canvas` (reference) :ref:`Example: edX as an LTI Provider to Blackboard` (reference) diff --git a/source/educators/how-tos/advanced_features/timed_exams.rst b/source/educators/how-tos/advanced_features/timed_exams.rst index c557b2085..5ffc3718f 100644 --- a/source/educators/how-tos/advanced_features/timed_exams.rst +++ b/source/educators/how-tos/advanced_features/timed_exams.rst @@ -6,6 +6,8 @@ Configure Timed Exams .. tags:: educator, how-to +.. _Enable Timed Exams: + ******************* Enable Timed Exams ******************* @@ -59,7 +61,7 @@ steps. If your course has the proctored exam feature enabled, the **Advanced** tab also shows options for :ref:`proctored and practice - proctored exams`. + proctored exams`. #. In the **Time Allotted** field, enter the length of time that you want learners to have to complete the problems in the subsection. Enter the time diff --git a/source/educators/how-tos/communication/configure-discussions.rst b/source/educators/how-tos/communication/configure-discussions.rst index f13a0339d..26e9d5244 100644 --- a/source/educators/how-tos/communication/configure-discussions.rst +++ b/source/educators/how-tos/communication/configure-discussions.rst @@ -88,9 +88,11 @@ Discussion list now includes the topic you added. configure these topics to be divided by cohort. For more information, see :ref:`Divide Course Wide Discussion Topics`. +.. _Enable Discussion on a Course Unit: -Upgraded Open edX Forum -======================= +********************************** +Enable Discussion on a Course Unit +********************************** Discussion can be enabled for a course unit, which is equivalent to adding a content-specific discussion topic in that unit in the :ref:`legacy version of diff --git a/source/educators/how-tos/communication/setting_up_divided_discussions.rst b/source/educators/how-tos/communication/setting_up_divided_discussions.rst index 4d5b1fb3b..c496718f6 100644 --- a/source/educators/how-tos/communication/setting_up_divided_discussions.rst +++ b/source/educators/how-tos/communication/setting_up_divided_discussions.rst @@ -12,8 +12,7 @@ Setting Up Divided Discussions By default, all :ref:`course-wide discussion topics` and :ref:`content-specific discussion topics` are unified: all learners can interact +Discussion Topics>` and :ref:`content-specific discussion topics` are unified: all learners can interact with all posts, responses, and comments. You can change discussion topics of either type to be divided or unified on the discussions configuration page (see :ref:`Create CourseWide Discussion Topics`). @@ -39,8 +38,7 @@ topics. Divide All Content-Specific Discussion Topics ********************************************* -When you :ref:`create content-specific discussion topics` by adding discussion components to units +When you :ref:`create content-specific discussion topics` by adding discussion components to units in Studio, these discussion topics are by default unified. All learners in the course can see and respond to posts from all other learners. You can change content-specific discussion topics to be divided, so that only members of the diff --git a/source/educators/how-tos/configure_prerequisite_content.rst b/source/educators/how-tos/configure_prerequisite_content.rst index 71dfec1ff..15c2808c6 100644 --- a/source/educators/how-tos/configure_prerequisite_content.rst +++ b/source/educators/how-tos/configure_prerequisite_content.rst @@ -12,7 +12,7 @@ in the course outline with a lock icon, and learners cannot view the subsection content until they have earned a minimum score in the prerequisite subsection. .. note:: - You must first :ref:`Enable Course Prerequisites` before + You must first :ref:`Set up Course Prerequisites` before prerequisite course subsections can be used. .. _enabling_subsection_gating: @@ -47,8 +47,7 @@ subsection, follow these steps. learners. .. note:: - You cannot use :ref:`open response assessments` that have a point value of 0 as the prerequisite for other course + You cannot use :ref:`Open Response Assessments` that have a point value of 0 as the prerequisite for other course subsections. #. Enable subsection prerequisites for your course. For more information, see @@ -114,7 +113,7 @@ subsection, follow these steps. :width: 600 .. note:: Prerequisite course subsection settings are not retained when - you :ref:`export or import a course`, or + you :ref:`Export a Course` and :ref:`Import a Course`, or when you :ref:`re-run a course`. .. seealso:: diff --git a/source/educators/how-tos/course_development/additional_video_options.rst b/source/educators/how-tos/course_development/additional_video_options.rst index 09fa4d7a2..946c17a73 100644 --- a/source/educators/how-tos/course_development/additional_video_options.rst +++ b/source/educators/how-tos/course_development/additional_video_options.rst @@ -132,7 +132,7 @@ Transcript * - **Transcript Languages** - The transcript files for any additional languages. For more - information, see :ref:`Transcripts in Additional Languages`. + information, see :ref:`Transcripts in Additional Languages`. * - **Download Transcript Allowed** - Specifies whether you want to allow learners to download the .srt or diff --git a/source/educators/how-tos/proctored_exams/create_proctored_exam_rpnow.rst b/source/educators/how-tos/proctored_exams/create_proctored_exam_rpnow.rst index 3bd3bba89..9cdc00e4f 100644 --- a/source/educators/how-tos/proctored_exams/create_proctored_exam_rpnow.rst +++ b/source/educators/how-tos/proctored_exams/create_proctored_exam_rpnow.rst @@ -65,7 +65,7 @@ Specify Exam Rules and Exceptions ********************************* By default, reviewers evaluate exam attempts according to a standard set of -:ref:`online proctoring rules ` that the +:ref:`online proctoring rules ` that the proctoring service has provided. .. note:: diff --git a/source/educators/references/advanced_features/planning_content_reuse.rst b/source/educators/references/advanced_features/planning_content_reuse.rst index 525e9dd91..32b4e8762 100644 --- a/source/educators/references/advanced_features/planning_content_reuse.rst +++ b/source/educators/references/advanced_features/planning_content_reuse.rst @@ -63,7 +63,7 @@ example, you can use a spreadsheet column to identify the type of content (for example, component, unit, subsection), and add their display names to the next column. Additional columns can contain the values that you use to construct the addresses for your LTI links. For more information about addressing content, -see :ref:`Determining Content Addresses`. +see :ref:`Determine Content Addresses`. Optionally, you can streamline the contents of units and subsections by removing components, or disable course features that you do not plan to use. diff --git a/source/educators/references/course_development/course_outline.rst b/source/educators/references/course_development/course_outline.rst index acd12cefd..399f4b717 100644 --- a/source/educators/references/course_development/course_outline.rst +++ b/source/educators/references/course_development/course_outline.rst @@ -20,7 +20,7 @@ building blocks in the course outline. * :ref:`Developing Course Sections` * :ref:`Developing Course Subsections` * :ref:`Developing Course Units` -* :ref:`Developing Course Components` +* :ref:`Add a Component` **************************** Open the Course Outline diff --git a/source/educators/references/course_development/course_units.rst b/source/educators/references/course_development/course_units.rst index fcaf5e092..f2bc941c3 100644 --- a/source/educators/references/course_development/course_units.rst +++ b/source/educators/references/course_development/course_units.rst @@ -25,7 +25,7 @@ What is a Unit? A unit is a part of a :ref:`subsection` that learners view as a single page. -A unit contains one or more :ref:`components`, +A unit contains one or more :ref:`components`, such as text with :ref:`HTML` markup, :ref:`problems`, a :ref:`discussion`, or a diff --git a/source/educators/references/course_development/text_components/text_components.rst b/source/educators/references/course_development/text_components/text_components.rst index 508508a7f..b746eedf6 100644 --- a/source/educators/references/course_development/text_components/text_components.rst +++ b/source/educators/references/course_development/text_components/text_components.rst @@ -18,7 +18,7 @@ with your Text components in a "visual" or WYSIWYG editor that hides the HTML code details, or in a "raw" editor that requires you to mark up your content. .. note:: - Review :ref:`Developing Your Course Index` and :ref:`Best Practices for HTML + Review :ref:`Developing Your Course Outline` and :ref:`Best Practices for HTML Markup` before you start working with Text components. diff --git a/source/educators/references/course_development/unit_workflow_and_status.rst b/source/educators/references/course_development/unit_workflow_and_status.rst index 6977af9f4..56dc99d7b 100644 --- a/source/educators/references/course_development/unit_workflow_and_status.rst +++ b/source/educators/references/course_development/unit_workflow_and_status.rst @@ -13,7 +13,7 @@ The typical workflow includes these steps. #. :ref:`Create a unit`. #. :ref:`Add components to the unit`. -#. :ref:`Modify components in the unit`. +#. :ref:`Modify components in the unit`. .. The following image could use some re-work to make the contrast greater. diff --git a/source/educators/references/proctored_exams/pt_proctored_exam_report.rst b/source/educators/references/proctored_exams/pt_proctored_exam_report.rst index 180312cf5..1c93775d1 100644 --- a/source/educators/references/proctored_exams/pt_proctored_exam_report.rst +++ b/source/educators/references/proctored_exams/pt_proctored_exam_report.rst @@ -144,7 +144,7 @@ Values in the ``review_status`` Column After learners complete a proctored exam, a reviewer from the proctoring service provider reviews the exam according to specific criteria, including the -:ref:`Online Proctoring Rules `. The value in the +:ref:`Online Proctoring Rules `. The value in the ``review_status`` column shows the outcome of the proctored exam review. Additionally, the value in the ``review_status`` column affects the following diff --git a/source/educators/references/proctored_exams/rpnow_proctored_exam_report.rst b/source/educators/references/proctored_exams/rpnow_proctored_exam_report.rst index fad480b8e..038d53633 100644 --- a/source/educators/references/proctored_exams/rpnow_proctored_exam_report.rst +++ b/source/educators/references/proctored_exams/rpnow_proctored_exam_report.rst @@ -140,7 +140,7 @@ Values in the ``review_status`` Column After learners complete a proctored exam, a reviewer from the proctoring service provider reviews the exam according to specific criteria, including the -:ref:`Online Proctoring Rules `. The value in the +:ref:`Online Proctoring Rules `. The value in the ``review_status`` column shows the outcome of the proctored exam review. Additionally, the value in the ``review_status`` column affects the following diff --git a/source/educators/references/workflow.rst b/source/educators/references/workflow.rst index b8356c42b..5cd303ede 100644 --- a/source/educators/references/workflow.rst +++ b/source/educators/references/workflow.rst @@ -33,7 +33,7 @@ Before you begin, you should understand the building blocks of an edX course. subsection contains one or more units. * :ref:`Course units ` are lessons in a subsection that learners view as single pages. A unit contains one or more components. -* :ref:`Course components` are objects within +* :ref:`Course components` are objects within units that contain your actual course content. .. _Creating New Course Content: From 56d352f3e90b639f81653a47ead672d8704c047e Mon Sep 17 00:00:00 2001 From: John Swope Date: Sat, 11 Jan 2025 15:53:22 -0800 Subject: [PATCH 3/6] Add Video Guidelines Doc --- source/educators/how-tos/add_video_quiz.rst | 2 + .../add_video_to_course.rst | 2 + .../additional_video_options.rst | 2 + source/educators/how-tos/create_video.rst | 2 + .../content_creation_management.rst | 1 + .../add_video_to_course.rst | 2 + .../course_development/video_guidelines.rst | 128 ++++++++++++++++++ 7 files changed, 139 insertions(+) create mode 100644 source/educators/references/course_development/video_guidelines.rst diff --git a/source/educators/how-tos/add_video_quiz.rst b/source/educators/how-tos/add_video_quiz.rst index 43a2a4b24..562da6805 100644 --- a/source/educators/how-tos/add_video_quiz.rst +++ b/source/educators/how-tos/add_video_quiz.rst @@ -21,6 +21,8 @@ It's possible to add quizzes directly to a video! Watch this for a how-to: :ref:`Troubleshoot Videos` (reference) + :ref:`Video Guidelines` (reference) + :ref:`Create a Video` (how-to) :ref:`Specifying Additional Video Options ` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/course_development/add_video_to_course.rst b/source/educators/how-tos/course_development/add_video_to_course.rst index 5a2d1aebe..58155eb63 100644 --- a/source/educators/how-tos/course_development/add_video_to_course.rst +++ b/source/educators/how-tos/course_development/add_video_to_course.rst @@ -43,6 +43,8 @@ To add a video, follow these steps. :ref:`Troubleshoot Videos` (reference) + :ref:`Video Guidelines` (reference) + :ref:`Create a Video` (how-to) :ref:`Specifying Additional Video Options ` (how-to) diff --git a/source/educators/how-tos/course_development/additional_video_options.rst b/source/educators/how-tos/course_development/additional_video_options.rst index 946c17a73..0a9f8d032 100644 --- a/source/educators/how-tos/course_development/additional_video_options.rst +++ b/source/educators/how-tos/course_development/additional_video_options.rst @@ -241,6 +241,8 @@ License :ref:`Troubleshoot Videos` (reference) + :ref:`Video Guidelines` (reference) + :ref:`Create a Video` (how-to) :ref:`Add an In Video Quiz` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/create_video.rst b/source/educators/how-tos/create_video.rst index 4cd6eaf32..f0e34ae36 100644 --- a/source/educators/how-tos/create_video.rst +++ b/source/educators/how-tos/create_video.rst @@ -21,6 +21,8 @@ This is how you can add a video to a course: :ref:`Troubleshoot Videos` (reference) + :ref:`Video Guidelines` (reference) + :ref:`Specifying Additional Video Options ` (how-to) :ref:`Add an In Video Quiz` (how-to) \ No newline at end of file diff --git a/source/educators/navigation/content_creation_management.rst b/source/educators/navigation/content_creation_management.rst index 6639ce9fd..390e72623 100644 --- a/source/educators/navigation/content_creation_management.rst +++ b/source/educators/navigation/content_creation_management.rst @@ -68,6 +68,7 @@ Add Video Components ../references/course_development/add_video_to_course.rst ../how-tos/course_development/add_video_to_course.rst ../references/course_development/troubleshoot_video.rst + ../references/course_development/video_guidelines.rst ../how-tos/create_video.rst ../how-tos/course_development/additional_video_options.rst ../how-tos/add_video_quiz.rst diff --git a/source/educators/references/course_development/add_video_to_course.rst b/source/educators/references/course_development/add_video_to_course.rst index f66537eb2..f105b94d0 100644 --- a/source/educators/references/course_development/add_video_to_course.rst +++ b/source/educators/references/course_development/add_video_to_course.rst @@ -85,6 +85,8 @@ that site. Keep the following guidelines in mind. :ref:`Troubleshoot Videos` (reference) + :ref:`Video Guidelines` (reference) + :ref:`Create a Video` (how-to) :ref:`Specifying Additional Video Options ` (how-to) diff --git a/source/educators/references/course_development/video_guidelines.rst b/source/educators/references/course_development/video_guidelines.rst new file mode 100644 index 000000000..5cef9e40a --- /dev/null +++ b/source/educators/references/course_development/video_guidelines.rst @@ -0,0 +1,128 @@ +.. _Video Guidelines: + +################ +Video Guidelines +################ + +Your videos can contain whatever content you want to include in the course. The +following resources can help you to create good video content that is based on +extensive experimental research in student learning. + +* The `Creating Video for the edX Platform`_ course +* Richard E. Mayer's `12 Principles of Multimedia Learning`_ + +When you create video files, keep the following guidelines in mind. + +.. contents:: + :local: + :depth: 1 + +****************** +General Guidelines +****************** + +* Videos should be as short as possible. Learners are more likely to finish + watching videos that are no more than 5-10 minutes long. +* Each video file that you upload must be less than 5GB in size. +* Each video should follow established :ref:`file naming conventions ` and :ref:`video compression specifications