From 27a076156cf27a23132d233c8b428c8cbb83452e Mon Sep 17 00:00:00 2001 From: Jesica Greco Date: Wed, 27 Nov 2024 13:46:52 -0300 Subject: [PATCH 1/8] docs: cleanup references fixing cleanup ref for resources_for_course_teams fixing external links cleaning up for enrollment_requirements.rst and message_text.rst cleaning up for scheduling_course.rst cleaning up for resources_for_open_edx.rst docs: cleanup for course_pacing.rst docs: adjusting error tables docs: cleanup for resources_for_course_teams docs: cleanup for roles_for_viewing.rst docs: cleanup for gradebook_assignment_types.rst docs: adjusting reference docs learner_view_of_grades doc being cleaned up. --- .../communication/automatic_email.rst | 4 +- source/educators/references/course_pacing.rst | 16 ++--- .../grading/gradebook_assignment_types.rst | 8 +-- .../grading/learner_view_of_grades.rst | 4 +- .../references/resources_for_course_teams.rst | 72 +++++++++---------- .../references/resources_for_open_edx.rst | 6 +- .../course_highlight_message_text.rst | 15 ++-- .../references/roles_for_viewing.rst | 4 +- .../references/scheduling_course.rst | 24 +++---- .../references/setting_course_pacing.rst | 18 ++--- .../enrollment_requirements.rst | 12 ++-- 11 files changed, 93 insertions(+), 90 deletions(-) diff --git a/source/educators/references/communication/automatic_email.rst b/source/educators/references/communication/automatic_email.rst index 730f3dac0..cb554d125 100644 --- a/source/educators/references/communication/automatic_email.rst +++ b/source/educators/references/communication/automatic_email.rst @@ -181,9 +181,9 @@ Messages`. .. _Discussion Notification: -================================ +======================= Discussion Notification -================================ +======================= After a learner or course team member creates a post in the course discussions, edX sends the following email message the first time a learner or course team member replies to the original post. diff --git a/source/educators/references/course_pacing.rst b/source/educators/references/course_pacing.rst index 85023986a..34dbdad08 100644 --- a/source/educators/references/course_pacing.rst +++ b/source/educators/references/course_pacing.rst @@ -1,13 +1,12 @@ +############# Course Pacing -##################### +############# .. tags:: educator, reference - - - +********************* Setting Course Pacing -*********************** +********************* .. sidebar:: Course Schedule and Details @@ -18,18 +17,19 @@ Setting Course Pacing You can set a schedule for your course, including when content is released and due dates for assignments. You can allow learners to work at their own pace, as long as they complete the course within the course run time period. +************************ Instructor-Paced Courses -***************************** +************************ Courses that follow a schedule that you set are known as instructor-paced courses. Select :guilabel:`Instructor-Paced` in the Course Schedule and Details screen. +****************** Self-Paced Courses -******************* +****************** Courses that allow learners to work at their own pace, as long as they are finished by the time the course ends, are known as self-paced courses. These courses offer learners flexibility to modify the assignment dates as needed. Select :guilabel:`Self-Paced` in the Course Schedule and Details screen. - .. seealso:: Beta Test a Course (task) diff --git a/source/educators/references/grading/gradebook_assignment_types.rst b/source/educators/references/grading/gradebook_assignment_types.rst index 6c51ad87e..cbdfb87f9 100644 --- a/source/educators/references/grading/gradebook_assignment_types.rst +++ b/source/educators/references/grading/gradebook_assignment_types.rst @@ -1,8 +1,8 @@ .. _Gradebook Assignment Types: -****************************** +########################## Gradebook Assignment Types -****************************** +########################## .. tags:: educator, reference @@ -36,9 +36,9 @@ To create a new assignment type, in the bottom of the Grading page, select and allowing droppable assignments. -========================== +********************** Assignment Type Fields -========================== +********************** You configure the following fields for each assignment type. diff --git a/source/educators/references/grading/learner_view_of_grades.rst b/source/educators/references/grading/learner_view_of_grades.rst index d598a85fb..d96790eb3 100644 --- a/source/educators/references/grading/learner_view_of_grades.rst +++ b/source/educators/references/grading/learner_view_of_grades.rst @@ -1,8 +1,8 @@ .. _The Learner View of Grades: -******************************************** +########################################## The Learner View of Grades (Progress Page) -******************************************** +########################################## .. tags:: educator, reference diff --git a/source/educators/references/resources_for_course_teams.rst b/source/educators/references/resources_for_course_teams.rst index adb9c966d..01f888216 100644 --- a/source/educators/references/resources_for_course_teams.rst +++ b/source/educators/references/resources_for_course_teams.rst @@ -1,58 +1,58 @@ -********************************** -Resources for edx.org Course Teams -********************************** +################################### +Resources for Open edX Course Teams +################################### .. tags:: educator, reference Course teams include faculty, instructional designers, course staff, discussion moderators, and others who contribute to the creation and delivery of courses -on edx.org or edX Edge. +on Open edX platform. -====================================== -The edX Course Creator Series -====================================== +********************************** +The Open edX Course Creator Series +********************************** -The courses in the edX Course Creator Series provide foundational knowledge -about using the edX platform to deliver educational experiences. These courses -are available on edx.org. +The courses in the Open edX Course Creator Series provide foundational knowledge +about using the Open edX platform to deliver educational experiences. These courses +are available on Open edX platform. .. contents:: :local: :depth: 1 -edX101: Overview of Creating a Course -************************************** +Open edX101: Overview of Creating a Course +========================================== -The `edX101`_ course is designed to provide a high-level overview of the course -creation and delivery process using Studio and the edX LMS. It also highlights -the extensive capabilities of the edX platform. +The `Open edX101 `_ course is designed to provide a high-level overview of the course +creation and delivery process using Studio and the Open edX LMS. It also highlights +the extensive capabilities of the Open edX platform. -StudioX: Creating a Course with edX Studio -************************************************* +StudioX: Creating a Course with Open edX Studio +=============================================== -After you complete edX101, "StudioX" provides more detail about using Studio +After you complete Open edX101, "StudioX" provides more detail about using Studio to create a course, add different types of content, and configure your course to provide an optimal online learning experience. -BlendedX: Blended Learning with edX -************************************ +BlendedX: Blended Learning with Open edX +======================================== In "BlendedX" you explore ways to blend educational technology with traditional classroom learning to improve educational outcomes. -VideoX: Creating Video for the edX Platform -************************************************* +VideoX: Creating Video for the Open edX Platform +================================================ "VideoX" presents strategies for creating videos for course content and course marketing. The course provides step-by-step instructions for every stage of -video creation, and includes links to exemplary sample videos created by edX +video creation, and includes links to exemplary sample videos created by the Open edX partner institutions. -============== +************* Documentation -============== +************* -Documentation for course teams is available from the docs.edx.org web page. +Documentation for course teams is available from the docs.openedx.org web page. * `Building and Running an Open edX Course`_ is a comprehensive guide with concepts and procedures to help you build a course in Studio and then @@ -67,29 +67,25 @@ a PDF version, select **v: latest** at the lower right of the page, then select **PDF**. .. note:: If you use the Safari browser, be aware that it does not support the - search feature for the HTML versions of the edX guides. This is a known + search feature for the HTML versions of the Open edX guides. This is a known limitation. -====== +***** Email -====== +***** To receive and share information by email, course team members can: -* Subscribe to announcements and other new topics in the edX Partner +* Subscribe to announcements and other new topics in the Open edX Partner Portal or the Open edX Portal. For information about how to subscribe, see the :doc:`Release Announcements through the Open edX Portal <../../community/how-tos/receive_announcements_by_email>` * Join the `openedx-studio`_ Google group to ask questions and participate in - discussions with peers at other edX partner organizations and edX staffers. + discussions with peers at other Open edX partner organizations and Open edX staffers. -==================== +******************* Wikis and Web Sites -==================== +******************* -The edX product team maintains public product roadmaps on :ref:`the Open edX -Portal` and :ref:`the edX Partner Portal`. +The Open edX product team maintains public product roadmaps on `the Open edX Portal ` and `the Open edX Commnity `_. -The `edX Partner Support`_ site for edX partners hosts discussions that are -monitored by edX staff. \ No newline at end of file diff --git a/source/educators/references/resources_for_open_edx.rst b/source/educators/references/resources_for_open_edx.rst index 2a621b1f9..d08d083bb 100644 --- a/source/educators/references/resources_for_open_edx.rst +++ b/source/educators/references/resources_for_open_edx.rst @@ -1,10 +1,10 @@ -************************** +###################### Resources for Open edX -************************** +###################### .. tags:: educator, reference Hosting providers, platform extenders, core contributors, and course staff all -use Open edX. EdX provides release-specific documentation, as well as the +use Open edX. Open edX platform provides release-specific documentation, as well as the latest version of all guides, for Open edX users. See the `Open edX documentation`_ page for a list of the documentation that is available. \ No newline at end of file diff --git a/source/educators/references/reusable_references/course_highlight_message_text.rst b/source/educators/references/reusable_references/course_highlight_message_text.rst index 14a2f55e4..a48fc308d 100644 --- a/source/educators/references/reusable_references/course_highlight_message_text.rst +++ b/source/educators/references/reusable_references/course_highlight_message_text.rst @@ -1,21 +1,28 @@ + +~~~~~~~~~~~~~~~~~~~~~~~~ +Course Highlight Message +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. tags:: educator, reference + :: - Sender: Creating a Course with edX Studio + Sender: Creating a Course with Open edX Studio Subject: Welcome to week 1 - We hope you're enjoying Creating a Course with edX Studio! We want to let + We hope you're enjoying Creating a Course with Open edX Studio! We want to let you know what you can look forward to this week: * Learn how to take StudioX and pass the course. - * Get access to edX Studio on Edge or Open edX. + * Get access to Open edX Studio on Edge or Open edX platform. * Meet the rest of the course author community. With self-paced courses, you learn on your own schedule. We encourage you to spend time with the course each week. Your focused attention will pay off in the end! -In addition, edX appends the following message to the end of the course +In addition, Open edX platform appends the following message to the end of the course highlight message for weeks 2 and 3 if the learner hasn't upgraded to the verified enrollment track. diff --git a/source/educators/references/roles_for_viewing.rst b/source/educators/references/roles_for_viewing.rst index 914568fae..848a8df76 100644 --- a/source/educators/references/roles_for_viewing.rst +++ b/source/educators/references/roles_for_viewing.rst @@ -1,8 +1,8 @@ .. _Roles for Viewing Course Content: -*************************************** +##################################### Viewing Course Content Based on Roles -*************************************** +##################################### .. tags:: educator, reference diff --git a/source/educators/references/scheduling_course.rst b/source/educators/references/scheduling_course.rst index 86ab93b82..ea42c95b1 100644 --- a/source/educators/references/scheduling_course.rst +++ b/source/educators/references/scheduling_course.rst @@ -13,17 +13,17 @@ see :ref:`Creating a Course About Page `. .. _Guidelines for Start and End Dates: -******************************************* +********************************** Guidelines for Start and End Dates -******************************************* +********************************** The start and end dates you set for your course are important for prospective and current learners. Current learners see your course start or end date on their dashboards. You should consider your course dates carefully. -============================ +************************** Course Start Date and Time -============================ +************************** The course start date and time specify when learners can access published course content. By default, the course start date and time are set to @@ -55,9 +55,9 @@ content before the course start date, see :ref:`Beta_Testing`. the start date as "Coming Soon". For more information, see :ref:`Advertise a Different Start Date `. -============================ +************************ Course End Date and Time -============================ +************************ The course end date and time specify when learners can no longer earn credit toward certificates. Learners can continue to complete available coursework, @@ -73,9 +73,9 @@ details, see :ref:`Hide a Subsection After its Due Date Date: Wed, 4 Dec 2024 16:00:48 -0300 Subject: [PATCH 2/8] Update source/educators/references/resources_for_course_teams.rst Co-authored-by: Sarina Canelake --- source/educators/references/resources_for_course_teams.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/resources_for_course_teams.rst b/source/educators/references/resources_for_course_teams.rst index 01f888216..9c7e77bd3 100644 --- a/source/educators/references/resources_for_course_teams.rst +++ b/source/educators/references/resources_for_course_teams.rst @@ -6,7 +6,7 @@ Resources for Open edX Course Teams Course teams include faculty, instructional designers, course staff, discussion moderators, and others who contribute to the creation and delivery of courses -on Open edX platform. +on an Open edX site. ********************************** The Open edX Course Creator Series From 7d4edbddf01f64c3dfecbc15ed378329914f92c9 Mon Sep 17 00:00:00 2001 From: jesgreco <74380129+jesgreco@users.noreply.github.com> Date: Wed, 4 Dec 2024 16:03:45 -0300 Subject: [PATCH 3/8] Update source/educators/references/resources_for_course_teams.rst Co-authored-by: Sarina Canelake --- source/educators/references/resources_for_course_teams.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/resources_for_course_teams.rst b/source/educators/references/resources_for_course_teams.rst index 9c7e77bd3..cf58f5a77 100644 --- a/source/educators/references/resources_for_course_teams.rst +++ b/source/educators/references/resources_for_course_teams.rst @@ -23,7 +23,7 @@ are available on Open edX platform. Open edX101: Overview of Creating a Course ========================================== -The `Open edX101 `_ course is designed to provide a high-level overview of the course +The `Open edX Demo Course `_ course is designed to provide a high-level overview of the course creation and delivery process using Studio and the Open edX LMS. It also highlights the extensive capabilities of the Open edX platform. From e242d0918b72d651c84264c0903e3fed8e9bd66b Mon Sep 17 00:00:00 2001 From: jesgreco <74380129+jesgreco@users.noreply.github.com> Date: Wed, 4 Dec 2024 16:11:58 -0300 Subject: [PATCH 4/8] Update source/educators/references/student_management/enrollment_requirements.rst Co-authored-by: Sarina Canelake --- .../references/student_management/enrollment_requirements.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/student_management/enrollment_requirements.rst b/source/educators/references/student_management/enrollment_requirements.rst index 10bf84bb9..5b5eacd4a 100644 --- a/source/educators/references/student_management/enrollment_requirements.rst +++ b/source/educators/references/student_management/enrollment_requirements.rst @@ -33,7 +33,7 @@ Before a learner can enroll in a course, he or she must complete these steps. As long as the course enrollment end date has not passed, learners who have registered and activated user accounts can enroll themselves in -``www.openedx.org`` courses, or can enroll in other courses if they know the URL. +courses on your Open edX instance, or can enroll in other courses on your instance if they know the URL. Course creators, Admins, and Staff, however, can enroll learners in a course either before or after the learners register their user accounts. From 697446a516a73ff51942ad0c261c18ff9594ae5e Mon Sep 17 00:00:00 2001 From: Jesica Greco Date: Wed, 4 Dec 2024 16:15:36 -0300 Subject: [PATCH 5/8] adjusting resource_for_course_teams doc --- .../educators/references/resources_for_course_teams.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/source/educators/references/resources_for_course_teams.rst b/source/educators/references/resources_for_course_teams.rst index cf58f5a77..089047a79 100644 --- a/source/educators/references/resources_for_course_teams.rst +++ b/source/educators/references/resources_for_course_teams.rst @@ -20,12 +20,10 @@ are available on Open edX platform. :local: :depth: 1 -Open edX101: Overview of Creating a Course -========================================== +Open edX Demo Course +==================== -The `Open edX Demo Course `_ course is designed to provide a high-level overview of the course -creation and delivery process using Studio and the Open edX LMS. It also highlights -the extensive capabilities of the Open edX platform. +The `Open edX Demo Course `_ course is designed to In discuss the tools and features that can leverage your learning program. After providing details about the platform, the course shows the different types of content that can be created, showcase the variety of assessment tools, and explore the different ways that you can engage your learners with social interactions. StudioX: Creating a Course with Open edX Studio =============================================== From ef778097e5ca7ace452e59e202527625a82b6694 Mon Sep 17 00:00:00 2001 From: Jesica Greco Date: Wed, 4 Dec 2024 16:57:56 -0300 Subject: [PATCH 6/8] adjusting docs based on Sarina's comments --- .../references/resources_for_course_teams.rst | 10 +--------- .../student_management/enrollment_requirements.rst | 3 +-- 2 files changed, 2 insertions(+), 11 deletions(-) diff --git a/source/educators/references/resources_for_course_teams.rst b/source/educators/references/resources_for_course_teams.rst index 089047a79..4bfdf426a 100644 --- a/source/educators/references/resources_for_course_teams.rst +++ b/source/educators/references/resources_for_course_teams.rst @@ -8,14 +8,6 @@ Course teams include faculty, instructional designers, course staff, discussion moderators, and others who contribute to the creation and delivery of courses on an Open edX site. -********************************** -The Open edX Course Creator Series -********************************** - -The courses in the Open edX Course Creator Series provide foundational knowledge -about using the Open edX platform to deliver educational experiences. These courses -are available on Open edX platform. - .. contents:: :local: :depth: 1 @@ -85,5 +77,5 @@ To receive and share information by email, course team members can: Wikis and Web Sites ******************* -The Open edX product team maintains public product roadmaps on `the Open edX Portal ` and `the Open edX Commnity `_. +The Open edX product team maintains public product roadmaps at this `public roadmap `_and, you can get involved with defining the roadmap by joining the `Product Working Group `_. diff --git a/source/educators/references/student_management/enrollment_requirements.rst b/source/educators/references/student_management/enrollment_requirements.rst index 5b5eacd4a..a3a53b0dd 100644 --- a/source/educators/references/student_management/enrollment_requirements.rst +++ b/source/educators/references/student_management/enrollment_requirements.rst @@ -25,8 +25,7 @@ Registration and Enrollment Before a learner can enroll in a course, he or she must complete these steps. -#. Register a user account, which includes supplying a valid email address, on - ``www.openedx.org``, or your implementation of the Open edX +#. Register a user account, which includes supplying a valid email address, or your implementation of the Open edX platform. Each platform requires a separate user account. #. Activate the registered account by following the emailed instructions. From 3f59599db53af59f177f33730a709f9d6e4e2c8b Mon Sep 17 00:00:00 2001 From: Jesica Greco Date: Wed, 4 Dec 2024 17:12:43 -0300 Subject: [PATCH 7/8] updating openedx reference as adjective --- source/educators/references/resources_for_open_edx.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/resources_for_open_edx.rst b/source/educators/references/resources_for_open_edx.rst index d08d083bb..5de2c8a4d 100644 --- a/source/educators/references/resources_for_open_edx.rst +++ b/source/educators/references/resources_for_open_edx.rst @@ -5,6 +5,6 @@ Resources for Open edX .. tags:: educator, reference Hosting providers, platform extenders, core contributors, and course staff all -use Open edX. Open edX platform provides release-specific documentation, as well as the +use Open edX platform which provides release-specific documentation, as well as the latest version of all guides, for Open edX users. See the `Open edX documentation`_ page for a list of the documentation that is available. \ No newline at end of file From bbecb1fa6bc30428de2449467d3e9fc97f612ad2 Mon Sep 17 00:00:00 2001 From: Jesica Greco Date: Thu, 5 Dec 2024 14:05:41 -0300 Subject: [PATCH 8/8] Removing sections asked by Sarina --- .../references/resources_for_course_teams.rst | 36 +------------------ 1 file changed, 1 insertion(+), 35 deletions(-) diff --git a/source/educators/references/resources_for_course_teams.rst b/source/educators/references/resources_for_course_teams.rst index 4bfdf426a..8872708c9 100644 --- a/source/educators/references/resources_for_course_teams.rst +++ b/source/educators/references/resources_for_course_teams.rst @@ -15,28 +15,7 @@ on an Open edX site. Open edX Demo Course ==================== -The `Open edX Demo Course `_ course is designed to In discuss the tools and features that can leverage your learning program. After providing details about the platform, the course shows the different types of content that can be created, showcase the variety of assessment tools, and explore the different ways that you can engage your learners with social interactions. - -StudioX: Creating a Course with Open edX Studio -=============================================== - -After you complete Open edX101, "StudioX" provides more detail about using Studio -to create a course, add different types of content, and configure your course -to provide an optimal online learning experience. - -BlendedX: Blended Learning with Open edX -======================================== - -In "BlendedX" you explore ways to blend educational technology with -traditional classroom learning to improve educational outcomes. - -VideoX: Creating Video for the Open edX Platform -================================================ - -"VideoX" presents strategies for creating videos for course content and course -marketing. The course provides step-by-step instructions for every stage of -video creation, and includes links to exemplary sample videos created by the Open edX -partner institutions. +The `Open edX Demo Course `_ course is designed to discuss the tools and features that you can leverage in your learning program. After providing details about the platform, the course shows the different types of content that can be created, showcase the variety of assessment tools, and explore the different ways that you can engage your learners with social interactions. ************* Documentation @@ -60,19 +39,6 @@ a PDF version, select **v: latest** at the lower right of the page, then select search feature for the HTML versions of the Open edX guides. This is a known limitation. -***** -Email -***** - -To receive and share information by email, course team members can: - -* Subscribe to announcements and other new topics in the Open edX Partner - Portal or the Open edX Portal. For information about how to subscribe, see - the :doc:`Release Announcements through the Open edX Portal <../../community/how-tos/receive_announcements_by_email>` - -* Join the `openedx-studio`_ Google group to ask questions and participate in - discussions with peers at other Open edX partner organizations and Open edX staffers. - ******************* Wikis and Web Sites *******************