From d1f4db8690337f02734c8db2ed3b236377e8a4d5 Mon Sep 17 00:00:00 2001 From: John Swope Date: Fri, 20 Dec 2024 17:54:16 -0500 Subject: [PATCH 1/6] Consolidate Course Re-run --- source/educators/how-tos/course_rerun.rst | 41 +++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/source/educators/how-tos/course_rerun.rst b/source/educators/how-tos/course_rerun.rst index 4a6a28af8..1e746a680 100644 --- a/source/educators/how-tos/course_rerun.rst +++ b/source/educators/how-tos/course_rerun.rst @@ -1,4 +1,4 @@ -.. _Re-Run Course: +.. _Re Run A Course: ################### Re-Run a Course @@ -33,9 +33,46 @@ Export and Import the Previous Course Use the Course Re-Run Option *************************************** -.. include:: rerun_course.rst +.. note:: Before you re-run a course, make sure that its settings and content + are complete. Additions and changes that you make to the original course + after you create the new course have no effect on the new course. +Only global or system administrators have the permissions needed to re-run +a course. To re-run a course, contact your system administrator. After your +system administrator creates a new course using the re-run feature, you can +complete the steps to :ref:`update the new course`. +To re-run a course, users who have the required permissions follow these +steps. +#. Sign in to Studio. Your dashboard lists the courses that you have access to as a course team member. + +#. Move your cursor over each row in the list of courses. The **Re-Run Course** and **View Live** options appear for each course. + +#. Locate the course you want to re-run and select **Re-Run Course**. The **Create a re-run of a course** page opens with values already supplied in the **Course Name**, **Organization**, and **Course Number** fields. + +#. In the **Course Run** field, indicate when the new course will be offered. + + Together, the course number, the organization, and the course run are used + to create the URL for the new course. The combination of these three + values must be unique for the new course. In addition, the total number of + characters used for the name, organization, number, and run must be 65 or + fewer. + +#. Select **Create Re-Run**. Your **My Courses** dashboard opens with a status message about the course creation process. + + Duplication of the course structure and content takes several minutes. You + can work in other parts of Studio or in the LMS, or on other web sites, + while the process runs. The new course appears on your **My Courses** + dashboard in Studio when configuration is complete. + +.. seealso:: + :class: dropdown + + :ref:`Re-running a Course ` (reference) + + :ref:`Course re-runs ` (how-to) + + :ref:`Update the New Course after a Re-Run ` (how-to) From dcafd40706395ad92ab1aa597723d71bd09187d7 Mon Sep 17 00:00:00 2001 From: John Swope Date: Fri, 20 Dec 2024 17:57:58 -0500 Subject: [PATCH 2/6] Navigation and Reference<>Target updates --- .../releasing-course/course_launching.rst | 4 +- .../set_up_course/require_entrance_exam.rst | 23 ++++-- .../navigation/components_activities.rst | 77 +++++++++++-------- .../course_number_guidelines.rst | 20 +++-- .../references/creating_certificates.rst | 34 +++++--- 5 files changed, 96 insertions(+), 62 deletions(-) diff --git a/source/educators/concepts/releasing-course/course_launching.rst b/source/educators/concepts/releasing-course/course_launching.rst index d82f818e4..788f01c31 100644 --- a/source/educators/concepts/releasing-course/course_launching.rst +++ b/source/educators/concepts/releasing-course/course_launching.rst @@ -24,7 +24,7 @@ Course Launch Checklist in Studio Your Course`. * **Create Your Course Grading Policy**: Establish your grading policy, including assignment types and passing score. All assignments add up to - 100%. See :ref:`Grading Index`. + 100%. See :ref:`Manage Learner Grades `. * **Enable Your Certificate**: Make sure that all text is correct, signatures have been uploaded, and the certificate has been activated. See :ref:`Setting Up Certificates`. * **Set Important Course Dates**: Establish your course schedule, including @@ -58,7 +58,7 @@ your course starts follow. * Check the course start date and time in Studio. See :ref:`Scheduling Your Course`. * Review the grading policy, and set a grace period for homework assignment - due dates. See :ref:`Grading Index`. + due dates. See :ref:`Manage Learner Grades `. * Confirm that any optional features that you want your course to include, such as learner cohorts, are enabled and configured. See :ref:`Cohorts Overview`. diff --git a/source/educators/how-tos/set_up_course/require_entrance_exam.rst b/source/educators/how-tos/set_up_course/require_entrance_exam.rst index 151c080e1..7569e225b 100644 --- a/source/educators/how-tos/set_up_course/require_entrance_exam.rst +++ b/source/educators/how-tos/set_up_course/require_entrance_exam.rst @@ -1,8 +1,8 @@ .. _Require an Entrance Exam: -**************************** +######################## Require an Entrance Exam -**************************** +######################## .. tags:: educator, how-to @@ -19,17 +19,17 @@ After you save your changes, Studio automatically creates an **Entrance Exam** section in your course outline. To add content to your entrance exam, go to the course outline. -======================= +*********************** Create an Entrance Exam -======================= +*********************** You create your course entrance exam from the course outline in Studio. Creating entrance exam content is just like creating other course content. For -more information, see :ref:`Course Components Index`. +more information, see the section on :ref:`Content Creation and Management `. -================================== +********************************** Adjust Scores in the Entrance Exam -================================== +********************************** If you find an error in the exam after learners have taken it, and corrections to the exam are unavoidable, you have several options to rescore the exam for @@ -53,4 +53,11 @@ Another option on the instructor dashboard is **Show Background Task History for Student**. If you reset learner attempts, rescore learner submissions, or delete learner state, the operation runs in the background. If you want to see a record of all the operations that have run for the entrance exam, select -**Show Background Task History for Student**. \ No newline at end of file +**Show Background Task History for Student**. + +.. seealso:: + :class: dropdown + + :ref:`Specify Prerequisite Courses and Exams` (how-to) + + :ref:`Set Up Course Prerequisites` (how-to) \ No newline at end of file diff --git a/source/educators/navigation/components_activities.rst b/source/educators/navigation/components_activities.rst index cad093c38..9216a4800 100644 --- a/source/educators/navigation/components_activities.rst +++ b/source/educators/navigation/components_activities.rst @@ -14,21 +14,25 @@ The Open edX® Problem Component :maxdepth: 2 :glob: + ../concepts/exercise_tools/create_exercises.rst + ../references/course_development/exercise_tools/create_exercises_and_tools.rst + ../references/course_development/create_problem.rst + ../references/course_development/problem_settings.rst + ../references/grading/gradebook_assignment_types.rst + ../concepts/instructional_design/feedback_best_practices.rst + ../references/course_development/exercise_tools/Section_adding_hints.rst ../how-tos/course_development/Subsection_configure_hints.rst + ../references/course_development/Section_partial_credit.rst ../how-tos/course_development/set_subsection_problem_date.rst ../references/course_development/Section_adding_tooltip.rst - ../references/course_development/Section_partial_credit.rst - ../references/course_development/exercise_tools/Section_adding_hints.rst ../references/course_development/advanced_problem_editor.rst - ../references/course_development/create_problem.rst - ../references/course_development/problem_settings.rst + ../how-tos/course_development/exercise_tools/add_hints_advanced_editor.rst ../references/course_development/modifying_released_problem.rst ../references/course_development/Section_learner_problem_view.rst - ../concepts/instructional_design/feedback_best_practices.rst - ../concepts/exercise_tools/create_exercises.rst - ../how-tos/course_development/exercise_tools/add_hints_advanced_editor.rst - ../references/grading/gradebook_assignment_types.rst - ../references/course_development/exercise_tools/create_exercises_and_tools.rst + + + + Chemical Equation Problem ******************************************************* @@ -37,8 +41,8 @@ Chemical Equation Problem :maxdepth: 2 :glob: - ../references/course_development/exercise_tools/chemical_equation_xml.rst ../how-tos/course_development/exercise_tools/add_chemical_equation.rst + ../references/course_development/exercise_tools/chemical_equation_xml.rst Circuit Schematic Builder Problem ******************************************************* @@ -101,11 +105,11 @@ Drag and Drop Problem :maxdepth: 2 :glob: - ../references/course_development/exercise_tools/drag_and_drop.rst ../concepts/exercise_tools/drag_and_drop.rst - ../how-tos/course_development/exercise_tools/use_dropdown_feedback.rst + ../references/course_development/exercise_tools/drag_and_drop.rst ../how-tos/course_development/exercise_tools/creating_a_drag_and_drop_problem.rst ../how-tos/course_development/exercise_tools/adding_dropdown.rst + ../how-tos/course_development/exercise_tools/use_dropdown_feedback.rst ../how-tos/course_development/exercise_tools/use_dropdown_hints.rst ../how-tos/drag_and_drop_deprecated.rst @@ -143,8 +147,8 @@ External Grader :maxdepth: 2 :glob: - ../references/course_development/exercise_tools/external_grader_requirements.rst ../concepts/exercise_tools/external_graders.rst + ../references/course_development/exercise_tools/external_grader_requirements.rst ../how-tos/course_development/exercise_tools/create_external_grader.rst Gene Explorer Tool @@ -163,9 +167,9 @@ Image Mapped Input Problem :maxdepth: 2 :glob: - ../references/course_development/exercise_tools/image_mapped_input_xml.rst ../references/course_development/exercise_tools/image_mapped_input.rst ../how-tos/course_development/exercise_tools/create_image_mapped_input.rst + ../references/course_development/exercise_tools/image_mapped_input_xml.rst Learner View ******************************************************* @@ -209,12 +213,13 @@ Multi-Select Problem :maxdepth: 2 :glob: - ../how-tos/add_checkbox.rst - ../references/course_development/exercise_tools/multi_select_xml.rst ../references/course_development/exercise_tools/multi_select.rst - ../references/course_development/exercise_tools/checkbox.rst + ../how-tos/add_checkbox.rst ../how-tos/course_development/exercise_tools/adding_multi_select.rst ../how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst + ../references/course_development/exercise_tools/multi_select_xml.rst + ../references/course_development/exercise_tools/checkbox.rst + Numerical Input Problem ******************************************************* @@ -224,12 +229,12 @@ Numerical Input Problem :glob: ../references/course_development/exercise_tools/numerical_input.rst + ../how-tos/course_development/exercise_tools/add_numerical_input_problem.rst ../references/course_development/exercise_tools/numerical_input_xml.rst ../how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst ../how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst ../how-tos/course_development/exercise_tools/create_problem_in_latex.rst ../how-tos/course_development/text_components/work_with_latex.rst - ../how-tos/course_development/exercise_tools/add_numerical_input_problem.rst .. _Nav Open Response Assessments: @@ -240,11 +245,12 @@ Open Response Assessments :maxdepth: 2 :glob: - ../references/course_development/exercise_tools/Access_ORA_Info.rst - ../references/course_development/exercise_tools/ORA_Staff_Grading.rst ../concepts/exercise_tools/OpenResponseAssessments.rst ../how-tos/course_development/exercise_tools/CreateORAAssignment.rst ../how-tos/course_development/exercise_tools/Manage_ORA_Assignment.rst + ../references/course_development/exercise_tools/ORA_Staff_Grading.rst + ../references/course_development/exercise_tools/Access_ORA_Info.rst + Oppia Exploration Tool ******************************************************* @@ -292,8 +298,8 @@ Problem with Adaptive Hint :maxdepth: 2 :glob: - ../references/course_development/exercise_tools/problem_hint_xml.rst ../how-tos/course_development/exercise_tools/create_problem_with_hint.rst + ../references/course_development/exercise_tools/problem_hint_xml.rst Proctored Exams ******************************************************* @@ -302,18 +308,19 @@ Proctored Exams :maxdepth: 2 :glob: - ../references/proctored_exams/rpnow_proctored_exam_report.rst - ../references/proctored_exams/online_proctoring_rules.rst - ../references/proctored_exams/pt_proctored_exam_report.rst - ../concepts/proctored_exams/preparing_learners_proctored_exams.rst ../concepts/proctored_exams/proctored_exams_overview.rst + ../concepts/proctored_exams/preparing_learners_proctored_exams.rst + ../how-tos/proctored_exams/enable_proctored_exams.rst + ../how-tos/proctored_exams/create_proctored_exam_pt.rst + ../references/proctored_exams/online_proctoring_rules.rst ../how-tos/proctored_exams/manage_proctored_exams.rst - ../how-tos/proctored_exams/review_rpnow_results.rst ../how-tos/proctored_exams/create_proctored_exam_rpnow.rst + ../references/proctored_exams/rpnow_proctored_exam_report.rst + ../how-tos/proctored_exams/review_rpnow_results.rst + ../references/proctored_exams/pt_proctored_exam_report.rst ../how-tos/proctored_exams/review_pt_results.rst ../how-tos/proctored_exams/allow_opt_out_proctored_exam.rst - ../how-tos/proctored_exams/enable_proctored_exams.rst - ../how-tos/proctored_exams/create_proctored_exam_pt.rst + Protex Protein Builder ******************************************************* @@ -352,12 +359,12 @@ Single Select Problem :maxdepth: 2 :glob: - ../references/course_development/exercise_tools/single_select_xml.rst - ../references/course_development/exercise_tools/multiple_choice.rst ../concepts/exercise_tools/single_select_overview.rst - ../how-tos/course_development/exercise_tools/edit_single_select_advanced.rst - ../how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst + ../references/course_development/exercise_tools/multiple_choice.rst ../how-tos/course_development/exercise_tools/add_single_select.rst + ../how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst + ../how-tos/course_development/exercise_tools/edit_single_select_advanced.rst + ../references/course_development/exercise_tools/single_select_xml.rst ../how-tos/add_multiple_choice.rst ../how-tos/add_dropdown.rst @@ -382,10 +389,12 @@ Text Input Problem :glob: ../references/course_development/exercise_tools/text_input.rst + ../how-tos/course_development/exercise_tools/add_text_input.rst ../how-tos/add_text_input.rst - ../references/course_development/exercise_tools/text_input_xml.rst ../how-tos/course_development/exercise_tools/edit_text_input_advanced.rst - ../how-tos/course_development/exercise_tools/add_text_input.rst + ../references/course_development/exercise_tools/text_input_xml.rst + + Timed Exams diff --git a/source/educators/references/course_development/course_number_guidelines.rst b/source/educators/references/course_development/course_number_guidelines.rst index ff5a3a8d5..af16b54cd 100644 --- a/source/educators/references/course_development/course_number_guidelines.rst +++ b/source/educators/references/course_development/course_number_guidelines.rst @@ -13,7 +13,7 @@ numbers that are easy to understand and remember. Course numbers have the following guidelines. * Course numbers can have a maximum of 10 characters. -* Characters can be letters, numbers, or periods. +* Characters can be letters, numbers or periods. * If a course consists of several modules, the course number can have an ending such as .1x or .2x. @@ -23,17 +23,25 @@ Course numbers have the following guidelines. the way that your course number appears in Studio and the LMS, see :ref:`Change the Course Number `. -====================== +********************** Example Course Numbers -====================== +********************** * CS002x * BIO1.1x and BIO1.2x +* CS101 +* BI01.1 and BI01.2 * 6.002.1x and 6.002.2x .. seealso:: - :class: dropdown + :class: dropdown - :ref:`Course Title Guidelines` (reference) + :ref:`Course Title Guidelines` (reference) - :ref:`Creating a New Course ` \ No newline at end of file + :ref:`Course and Program Images and Videos` (reference) + + :ref:`Course Description` (reference) + + :ref:`Additional Course Information` (reference) + + :ref:`Creating a New Course ` \ No newline at end of file diff --git a/source/educators/references/creating_certificates.rst b/source/educators/references/creating_certificates.rst index c920b519c..5bde8d196 100644 --- a/source/educators/references/creating_certificates.rst +++ b/source/educators/references/creating_certificates.rst @@ -10,16 +10,15 @@ This section describes how to create and manage certificates for your course. .. note:: - Before you can issue certificates, the administrator for your instance of - Open edX must configure the platform to allow course teams to generate and + Before you can issue certificates, the administrator for your instance + must configure the platform to allow course teams to generate and issue certificates. For more information, see - :ref:`Enable Certificates ` in *Installing, Configuring, and - Running the Open edX Platform*. + :ref:`Enable a Certificate `. For more information about certificates, see these additional topics. -* :ref:`Obtaining Certificate Data` -* :ref:`Ending a Course` +* :ref:`Access Certificate Data ` +* :ref:`Issuing Certificates ` For information about awarding badges for your course, see :ref:`Enable or @@ -50,17 +49,15 @@ certificates are available on the learner dashboard, the learner **Profile** page, and the course **Progress** page. For more information about issuing certificates, see :ref:`Issuing -Certificates `. +Certificates `. The design of certificates for your course, including your institution's -logo, are configured on your instance of Open edX. For more information, see -:ref:`Enable Certificates ` in *Installing, Configuring, and -Running the Open edX Platform*. - +logo, are configured on your instance. For more information, see +:ref:`Enable a Certificate `. .. The course start date limitation is not published for partners at this time. .. Confirmed March 9, 2017 that there's no hard requirement for having -.. activated certs before edX course starts. Although there is a procedural +.. activated certs before the course starts. Although there is a procedural .. requirement for announcing activated certs, courses are able to start if .. they have deactivated certs. @@ -73,3 +70,16 @@ Running the Open edX Platform*. For information about starting the course, see :ref:`Guidelines for Start and End Dates `. + +.. seealso:: + :class: dropdown + + :ref:`Enable a Certificate` (how-to) + + :ref:`Edit a Certificate` (how-to) + + :ref:`Set Up Certificates` (how-to) + + :ref:`Issuing Certificates` (how-to) + + :ref:`Enable Badges in Course` (how-to) \ No newline at end of file From d5aa0cf4a0dc02ce03561ebadce5632133e197cd Mon Sep 17 00:00:00 2001 From: John Swope Date: Fri, 20 Dec 2024 20:55:37 -0500 Subject: [PATCH 3/6] Delete rerun_course (it lives in course_rerun now) --- source/educators/how-tos/rerun_course.rst | 37 ----------------------- 1 file changed, 37 deletions(-) delete mode 100644 source/educators/how-tos/rerun_course.rst diff --git a/source/educators/how-tos/rerun_course.rst b/source/educators/how-tos/rerun_course.rst deleted file mode 100644 index 0d3091c97..000000000 --- a/source/educators/how-tos/rerun_course.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. note:: Before you re-run a course, make sure that its settings and content - are complete. Additions and changes that you make to the original course - after you create the new course have no effect on the new course. - -Only global or system administrators have the permissions needed to re-run -a course. To re-run a course, contact your system administrator. After your -system administrator creates a new course using the re-run feature, you can -complete the steps to :ref:`update the new course`. - -To re-run a course, users who have the required permissions follow these -steps. - -#. Sign in to Studio. Your dashboard lists the courses that you have access to as a course team member. - -#. Move your cursor over each row in the list of courses. The **Re-Run Course** and **View Live** options appear for each course. - -#. Locate the course you want to re-run and select **Re-Run Course**. The **Create a re-run of a course** page opens with values already supplied in the **Course Name**, **Organization**, and **Course Number** fields. - -#. In the **Course Run** field, indicate when the new course will be offered. - - Together, the course number, the organization, and the course run are used - to create the URL for the new course. The combination of these three - values must be unique for the new course. In addition, the total number of - characters used for the name, organization, number, and run must be 65 or - fewer. - -#. Select **Create Re-Run**. Your **My Courses** dashboard opens with a status message about the course creation process. - - Duplication of the course structure and content takes several minutes. You - can work in other parts of Studio or in the LMS, or on other web sites, - while the process runs. The new course appears on your **My Courses** - dashboard in Studio when configuration is complete. - -.. seealso:: - :class: dropdown - - :ref:`Updating a New Course after a Re-Run ` (how-to) \ No newline at end of file From df7cd5d8aa7f962b4b1a00d3b8a6404e2cdee01c Mon Sep 17 00:00:00 2001 From: John Swope Date: Fri, 20 Dec 2024 20:58:16 -0500 Subject: [PATCH 4/6] Add targets to docs --- source/educators/how-tos/course_reruns.rst | 2 ++ source/educators/how-tos/set_up_certificates.rst | 2 ++ source/educators/how-tos/set_up_prerequisites.rst | 2 ++ 3 files changed, 6 insertions(+) diff --git a/source/educators/how-tos/course_reruns.rst b/source/educators/how-tos/course_reruns.rst index 4f24f964b..d3e87e3cf 100644 --- a/source/educators/how-tos/course_reruns.rst +++ b/source/educators/how-tos/course_reruns.rst @@ -1,3 +1,5 @@ +.. _Course Reruns: + Course re-runs ############## diff --git a/source/educators/how-tos/set_up_certificates.rst b/source/educators/how-tos/set_up_certificates.rst index 9ebc15976..468057225 100644 --- a/source/educators/how-tos/set_up_certificates.rst +++ b/source/educators/how-tos/set_up_certificates.rst @@ -1,3 +1,5 @@ +.. _Set Up Certificates: + Set Up Certificates ################### diff --git a/source/educators/how-tos/set_up_prerequisites.rst b/source/educators/how-tos/set_up_prerequisites.rst index e933d74e0..f746e9910 100644 --- a/source/educators/how-tos/set_up_prerequisites.rst +++ b/source/educators/how-tos/set_up_prerequisites.rst @@ -1,3 +1,5 @@ +.. _Set up Course Prerequisites: + Set Up Course Prerequisites ########################### From 6e21b4f716c96a35b276ed5804c75700843ae456 Mon Sep 17 00:00:00 2001 From: jswope00 Date: Wed, 8 Jan 2025 15:16:37 -0500 Subject: [PATCH 5/6] Revise example course numbers --- .../course_development/course_number_guidelines.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/source/educators/references/course_development/course_number_guidelines.rst b/source/educators/references/course_development/course_number_guidelines.rst index af16b54cd..1243afdaa 100644 --- a/source/educators/references/course_development/course_number_guidelines.rst +++ b/source/educators/references/course_development/course_number_guidelines.rst @@ -27,8 +27,6 @@ Course numbers have the following guidelines. Example Course Numbers ********************** -* CS002x -* BIO1.1x and BIO1.2x * CS101 * BI01.1 and BI01.2 * 6.002.1x and 6.002.2x @@ -44,4 +42,4 @@ Example Course Numbers :ref:`Additional Course Information` (reference) - :ref:`Creating a New Course ` \ No newline at end of file + :ref:`Creating a New Course ` From c9d7e60bcb87e0fb29b2602a5fd0858de66707c2 Mon Sep 17 00:00:00 2001 From: jswope00 Date: Wed, 8 Jan 2025 16:48:04 -0500 Subject: [PATCH 6/6] Remove non-existent reference exercise_tools/checkbox is actually exercise_tools/multi_select which already exists in the TOC --- source/educators/navigation/components_activities.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/educators/navigation/components_activities.rst b/source/educators/navigation/components_activities.rst index a6c3bb580..6d2abf3f0 100644 --- a/source/educators/navigation/components_activities.rst +++ b/source/educators/navigation/components_activities.rst @@ -214,7 +214,6 @@ Multi-Select Problem ../how-tos/course_development/exercise_tools/adding_multi_select.rst ../how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst ../references/course_development/exercise_tools/multi_select_xml.rst - ../references/course_development/exercise_tools/checkbox.rst Numerical Input Problem