Skip to content

Commit

Permalink
docs: cleanup references
Browse files Browse the repository at this point in the history
fix automatic_email.rst and resources_for_course_teams.rst
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.
  • Loading branch information
jesica-greco-zocdoc authored and angonz committed Dec 3, 2024
1 parent 45d0866 commit 3599068
Show file tree
Hide file tree
Showing 11 changed files with 93 additions and 90 deletions.
4 changes: 2 additions & 2 deletions source/educators/references/communication/automatic_email.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
16 changes: 8 additions & 8 deletions source/educators/references/course_pacing.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
#############
Course Pacing
#####################
#############

.. tags:: educator, reference




*********************
Setting Course Pacing
***********************
*********************

.. sidebar:: Course Schedule and Details

Expand All @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _Gradebook Assignment Types:

******************************
##########################
Gradebook Assignment Types
******************************
##########################

.. tags:: educator, reference

Expand Down Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _The Learner View of Grades:

********************************************
##########################################
The Learner View of Grades (Progress Page)
********************************************
##########################################

.. tags:: educator, reference

Expand Down
72 changes: 34 additions & 38 deletions source/educators/references/resources_for_course_teams.rst
Original file line number Diff line number Diff line change
@@ -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 <https://sandbox.openedx.org/courses/course-v1:OpenedX+01-2024+2024-1/about>`_ 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
Expand All @@ -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<The Open edX Portal>` and :ref:`the edX Partner Portal<The edX Partner
Portal>`.
The Open edX product team maintains public product roadmaps on `the Open edX Portal <https://openedx.org/>` and `the Open edX Commnity <https://openedx.org/community/>`_.

The `edX Partner Support`_ site for edX partners hosts discussions that are
monitored by edX staff.
6 changes: 3 additions & 3 deletions source/educators/references/resources_for_open_edx.rst
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions source/educators/references/roles_for_viewing.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _Roles for Viewing Course Content:

***************************************
#####################################
Viewing Course Content Based on Roles
***************************************
#####################################

.. tags:: educator, reference

Expand Down
24 changes: 12 additions & 12 deletions source/educators/references/scheduling_course.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ see :ref:`Creating a Course About Page <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
Expand Down Expand Up @@ -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 <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,
Expand All @@ -73,9 +73,9 @@ details, see :ref:`Hide a Subsection After its Due Date <Hide a Subsection After
If you do not set a course end date, learners cannot access earned
certificates.

===============================
******************************
Enrollment Start Date and Time
===============================
******************************

As soon as enrollment starts, prospective learners can see your course in the
course catalog, view the course **About** page, and enroll in the course.
Expand All @@ -86,9 +86,9 @@ learners to both enroll in and prepare for the course.

.. _Enrollment End Date and Time:

===============================
****************************
Enrollment End Date and Time
===============================
****************************

The enrollment end date and time specify when learners can no longer enroll
in the course. Ensure that the enrollment end date is late enough to allow
Expand All @@ -98,9 +98,9 @@ than the course end date.

.. _View Start and End Dates:

========================================================
************************************************
The Learner's View of Course Start and End Dates
========================================================
************************************************

When learners browse courses, the start date for each course is visible in the
course catalog and in the course's About page.
Expand Down
18 changes: 9 additions & 9 deletions source/educators/references/setting_course_pacing.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.. _Setting Course Pacing:

*************
#############
Course Pacing
*************
#############

.. tags:: educator, reference

This topic describes the difference between instructor-paced and self-paced
courses.

===========================
*************************
Overview of Course Pacing
===========================
*************************

When you create an edX course, you can set the schedule of the course,
When you create an Open edX course, you can set the schedule of the course,
including due dates for assignments or exams, or you can allow learners to work
at their own pace. Courses that follow a schedule that you set are known as
instructor- paced courses. Courses that offer suggested due dates for
Expand All @@ -32,9 +32,9 @@ page. By default, courses are instructor-paced.
.. note::
You cannot change the course pacing after the course start date has passed.

=======================================
***************************************
Instructor-Paced and Self-Paced Courses
=======================================
***************************************

Instructor-paced courses progress at the pace that the course author sets. You
set release dates for content and due dates for assignments, and assignment due
Expand Down Expand Up @@ -89,9 +89,9 @@ Now, Personalized Learning Schedule can be adapted to have:
#. A mix of default and custom pacing, where the user sets custom pacing to some, but not all, graded assignments in a course. The rest of the assignments that are not set have default pacing applied to them.


========================================================
********************************************************
Setting Custom Pacing in Personalized Learning Schedules
========================================================
********************************************************

Once you have created a graded assignment in your self-paced course, the assignment is eligible to be included in
a learner’s Personalized Learning Schedule (PLS), and it will automatically inherit default pacing.
Expand Down
Loading

0 comments on commit 3599068

Please sign in to comment.