Skip to content

Commit

Permalink
Add seealso tables and remove edX references from various files
Browse files Browse the repository at this point in the history
* Test change by removing a line break

* Heading to changed into heading 1

* Corrected heading code

* Moved up in paragraph in one line. Changed the header.

* Changed heading 2 to heading 1. Corrected ssigned to assigned

* Changed heading 2 to heading 1.
Changed heading 3 to heading 2.

* Moved up in paragraph in one line. Changed the headings appropriately.

* Fixed heading.

* Changed heading.

* Moved up in paragraph in one line. Change heading.

* Change heading.

* Fixed headings.

* Changed headings.

* Changed headings.

* Changed headings.

* Changed headings.

* Changed headings.

* Changed headings.

* Changed headings.

* Moved up in paragraph in one line.

* Moved up in paragraph in one line.

* Moved up in paragraph in one line.
Changed heading.

* Changed headings.

* Moved up in paragraph in one line.

* Moved up in paragraph in one line.

* Moved up in paragraph in one line.

* Moved up in paragraph in one line.
Changed heading.

* Changed headings.

* Change heading.

* Changed headings.

* Changed headings.

* Changed headings.
Corrected grammar.

* Change heading.

* Change heading.

* See Also Links for Video

* Docs clean up add see also tables

* Update component and activity navigation

* edit editor for rst formatting

* add see also table
edit to remove edx references

* edit to remove edx reference

* Change heading.

* Corrected spelling.
Changed heading.

* Changed headings.

* Changed headings.

* Change heading.

* Change heading.

* Change heading.

* Changed headings.

* Corrected spelling.

* Corrected spellings.

* Corrected spellings.
Changed heading.

* Corrected spellings.

* Corrected spellings.
Changed heading.

* Add see also to Control Content Visibility & Access section

* Add see also to Written content

* edited rst header

* Add see also to copy and paste content and unit pages

* Add see also to hide units and set restrictions

* Add see also to importing SCORM

* Remove references to edx in beta testing

* Add see also to Add an image

* Add tag and rst header to create course about page

* Ass see also to describe course

* Ass see all to licensing course

* Add tag and rst header

* Add see also to course staff

* Add see also, edit references to edx

* Add see also to grade report and progress pages

* Edit see also table learner data

* Edit see also table certificate report columns

* Add see also to entrance exam

* Add see also to prerequisites

* Add tag and rst header

* Edit tags course rerun and add see also

* Error in make html removing changes - to be edited again

* Add see also tables to certificate pages

* Add see also table

* Add tags and see also tables to ID concepts

* Add see also tables to course run information pages

* Add see also tables to course pacing, course schedule, course dates; adding rst formatting

* Add see also and format

* See also table edits and formatting

* Resolve conflict in resources_for_course_teams.rst

* Edit see also tables to fix errors
Edit targets for spelling mistakes

* Edit to remove references to edx/only edx.

* Edit to remove references to edx/only edx

* Edit to fix broken link

* Edit to remove references to edx/only edx

* Edit to fix broken link

* Edit header
Edit to remove references to edx/only edx

* Add see also table

* Add see also table

* Edit to fix broken link

* Edit to add see also table

* Add see also table

* Edit to fix broken links

* Edit to remove references to edx/only edx

* Edit to fix broken link

* Edit to remove references to edx/only edx and edx mobile apps

* Fix reference to Open edX

* Fix reference to Open edX

* Change reference to Open edX

* Abstract several direct references to Open edX

* Apply suggestions from code review

Mainly two changes:
1. Add spaces between See Also links so that they render with line breaks. 
2. Fix missed references to edX.org

Co-authored-by: Sarina Canelake <[email protected]>

* Replace some more challenging edX references, including references in Accessibility guides

* Additional replacements of legacy edX references

* Fix external links to legacy references

* Resolve See Also formatting

* See also spacing issue

* Merge reusable stub file rerun_course into course_rerun file

* Validate information in the student profile report and remove legacy references

---------

Co-authored-by: leiramagpantay <[email protected]>
Co-authored-by: Shannon Rushe <[email protected]>
Co-authored-by: Sarina Canelake <[email protected]>
  • Loading branch information
4 people authored Jan 8, 2025
1 parent b615892 commit 42d8ccb
Show file tree
Hide file tree
Showing 22 changed files with 336 additions and 116 deletions.
15 changes: 8 additions & 7 deletions source/educators/concepts/data/learner_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,11 @@ any time after you create the course.

.. _PII:

***************************************************************
**********************************************
Guidance for Working with Personal Information
***************************************************************
**********************************************

The information that edX collects from site registrants includes personal
information that can be used to identify, contact, and locate individuals. This
The information that your instance collects from site registrants includes personal information that can be used to identify, contact, and locate individuals. This
information is available to course team members with the Admin or Staff role
for the learners who are enrolled in their courses.

Expand All @@ -45,9 +44,9 @@ For information about course enrollment, see :ref:`Enrollment`.
About Learner-Reported Data
===========================

When learners create, or register, their user accounts, they select a public
When learners create or register their user accounts, they select a public
username and supply their full names and email addresses. Learners also have
the option to provide personal demographic information, including highest
the option to provide personal demographic information, including the highest
level of education completed, gender, year of birth, and preferred language.
Because this information is optional, not all of the learners who are enrolled
in your course provide it.
Expand Down Expand Up @@ -75,4 +74,6 @@ understanding of how the learner population changes over time.

:ref:`View and download student data` (how-to)

:ref:`Access Anonymized Learner IDs <Access_anonymized>` (how-to)
:ref:`Access Anonymized Learner IDs <Access_anonymized>` (how-to)

:ref:`Manage Learner Grades <Grades>` (how-to)
Original file line number Diff line number Diff line change
Expand Up @@ -217,4 +217,11 @@ Templates for the Information Collection phase that may be helpful:

* :ref:`Support Calendar Template<SupportCalendarTemplate>`

Remember: Course development is an iterative process. It is important to assume that there will be some changes made after the first group of learners completes the course and provides feedback.
Remember: Course development is an iterative process. It is important to assume that there will be some changes made after the first group of learners completes the course and provides feedback.

.. seealso::
:class: dropdown

:ref:`Instructional Design Overview` (concept)

:ref:`Instructional Design Templates` (concept)
Original file line number Diff line number Diff line change
Expand Up @@ -355,4 +355,6 @@ As you get started building your online course on your platform, here are five i
.. seealso::
:class: dropdown

:ref:`Course Development Process` (concept)

:ref:`Instructional Design Templates` (concept)
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,6 @@ If your team is involved in the delivery of a course, you may want to spend some
.. seealso::
:class: dropdown

:ref:`Instructional Design Overview` (concept)
:ref:`Instructional Design Overview` (concept)

:ref:`Course Development Process` (concept)
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,19 @@ 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 <Developing Your Course Index>`.
outline, see the section on :ref:`Creating a Course in Open edX® <Creating Course TOC>`.

.. seealso::
:class: dropdown

:ref:`Course Title Guidelines` (reference)

:ref:`Creating Number Guidelines` (reference)

:ref:`Course and Program Images and Videos` (reference)

:ref:`Course Description` (reference)

:ref:`Additional Course Information` (reference)

:ref:`Creating a New Course <Create a New Course>`
8 changes: 4 additions & 4 deletions source/educators/concepts/releasing-course/beta_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,10 @@ reluctant to provide feedback, or overly zealous.

If you do want a team member to be a beta tester, note that the privileges of
the Staff or Admin role override those of a beta tester. The team member must
use a different, second email address to create an additional edX account and
use a different, second email address to create an additional account and
enroll in the course, and the course team must assign only the beta tester role
to that edX account. The course team member experiences the course as a learner
only when she signs in to edX using the beta tester account.
to that account. The course team member experiences the course as a learner
only when she signs in using the beta tester account.

.. _What_Test:

Expand All @@ -124,7 +124,7 @@ Beta testers should interact with everything in the course.

* Complete all problems.

Beta testers can use a desktop computer to access an edX website, the edX
Beta testers can use a desktop computer to access your course website, the
mobile app on a smartphone, or both to complete their tests. As they work,
beta testers log issues and questions for the course team.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _Embed Google Calendar:

*******************************************
##########################################
Embedding a Google Calendar in Your Course
*******************************************
##########################################

.. tags:: educator, how-to

Expand All @@ -14,9 +14,9 @@ To embed a Google Calendar in your course, follow these steps.

.. _Enable the Google Calendars Tool:

================================================
********************************
Enable the Google Calendars Tool
================================================
********************************

Before you can add Google Calendars to your course, you must enable the Google
Calendars tool in Studio or OLX (open learning XML).
Expand All @@ -30,8 +30,9 @@ Alternatively, you can use OLX to enable the Google Calendars tool.

.. _Enable Google Calendars in OLX:

******************************
Enable Google Calendars in OLX
**********************************************
******************************

To enable Google Calendars in your course, you edit the XML file that defines
the course structure. You locate the ``course`` element's ``advanced-modules``
Expand All @@ -53,9 +54,9 @@ For more information, see `OLX Course Building Blocks`_ in the

.. _Make the Google Calendar Public and Obtain Its ID:

===================================================
*************************************************
Make the Google Calendar Public and Obtain Its ID
===================================================
*************************************************

Before you can add a Google Calendar to your course, you must make the Calendar
public and obtain its ID.
Expand All @@ -65,8 +66,9 @@ public and obtain its ID.
Because the software is subject to change by its owner, the steps provided
here are intended as guidelines and not as an exact procedure.

*******************************
Make the Google Calendar Public
**********************************************
*******************************

#. Open the Google Calendar.
#. From the **Settings** menu, select **Settings**.
Expand All @@ -91,8 +93,9 @@ Make the Google Calendar Public

.. _Obtain the Google Calendar ID:

******************************
Obtain the Google Calendar ID
**********************************************
******************************

#. On the **Calendars** tab, select the name of the calendar.
#. Select the **Calendar Details** tab.
Expand All @@ -113,17 +116,18 @@ Obtain the Google Calendar ID

.. _Add a Google Calendar in the Course Body:

========================================
****************************************
Add a Google Calendar in the Course Body
========================================
****************************************

To add a Google calendar in the course body, you create an advanced component
in Studio or create a Google Calendar XBlock in OLX.

.. _Add a Google Calendar Component in edX Studio:
.. _Add a Google Calendar Component in Studio:

Add a Google Calendar Component in edX Studio
**********************************************
**************************************************
Add a Google Calendar Component in Open edX Studio
**************************************************

Make sure that you :ref:`enable Google Calendars<Enable the Google Calendars
Tool>` for your course before you add a Google Calendar component.
Expand All @@ -136,8 +140,7 @@ To add a Google Calendar component, follow these steps.
#. Under **Add New Component**, select **Advanced**, and then select **Google
Calendar**.

The new component is added to the unit, with the default edX Google Calendar
embedded.
The new component is added to the unit.

#. In the new component, select **Edit**.

Expand All @@ -158,8 +161,9 @@ Google Calendar will appear to learners.

.. _Add a Google Calendar XBlock in OLX:

***********************************
Add a Google Calendar XBlock in OLX
**********************************************
***********************************

To add a Google Calendar XBlock in OLX, create the ``google-calendar`` element.
You can embed this element in the ``vertical`` element, or you can embed this
Expand All @@ -179,7 +183,7 @@ The value of the ``calendar_id`` attribute is the calendar ID that you copied
in the :ref:`Obtain the Google Calendar ID` task.

.. note::
The edX Learning Management System sets the height and width values for
The Learning Management System sets the height and width values for
Google Calendars. If you add these attributes, the LMS overrides your
changes.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
.. _OLX Completion:

****************************************
########################################
Add the Completion Tool to an OLX Course
****************************************
########################################

.. tags:: educator, how-to

To add the completion tool to a unit in an OLX (open learning XML) course, it
is sufficient to add the ``<done>`` tag to the OLX.

EdX recommends that you also explicitly specify a ``url_name`` within the
It is recommended that you also explicitly specify a ``url_name`` within the
``<done>`` tag, as shown in the following example. If you do not explicitly
specify a ``url_name``, a value is automatically assigned, which can be
problematic if the same course is imported several times. For example, if the
``url_name`` value is automatically generated each time you import your
course, and if you import your course more than once, the learner state for
the associated problems is lost each time a new ``url_name`` value is
ssigned.
the associated problems is lost each time a new ``url_name`` value is assigned.

.. code-block:: xml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ The following diagram outlines the general process for adding videos to a course
:alt: The process for adding videos to a course, as outlined in the following
numbered steps.

#. The course team :ref:`prepares to add videos to the course <Preparing a
Video>`. These steps can happen simultaneously.
#. The course team :ref:`prepares to add videos to the course <Preparing a Video>`. These steps can happen simultaneously.

* The course team sets up a third party :ref:`hosting service <Set Up
a Hosting Service>` to provide a location for course videos.
Expand All @@ -28,6 +27,19 @@ The following diagram outlines the general process for adding videos to a course
and adds the video location to the components.

#. The course team :ref:`Add a Transcript` in
the video component.
the video component.

.. seealso::
:class: dropdown

:ref:`Introduction to Video` (reference)

:ref:`Add a Video` (how-to)

:ref:`Troubleshoot Videos` (reference)

:ref:`Create a Video` (how-to)

:ref:`Specifying Additional Video Options <Additional Video Options>` (how-to)

:ref:`Add an In Video Quiz` (how-to)
30 changes: 22 additions & 8 deletions source/educators/how-tos/set_up_course/edit_course_about.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _Edit Your Course:

*************
#############
Edit a Course
*************
#############

.. tags:: educator, how-to

Expand All @@ -13,8 +13,7 @@ dates<Scheduling Your Course>`, or developing the :ref:`course
outline<Developing Your Course Outline>`.

When you return to Studio later, your **My Courses** dashboard page lists
the courses that you created as well as any courses for which you have course
team privileges.
the courses that you created as well as any courses for which you have course team privileges.

.. image:: /_images/educator_how_tos/open_course.png
:width: 600
Expand Down Expand Up @@ -45,11 +44,10 @@ change the way that your course title and number appear in Studio and the LMS.
Change the Course Title
=======================

To change the way that your course title appears in Studio and the LMS, follow
these steps.
To change the way that your course title appears in Studio and the LMS, follow these steps.

.. note::
EdX does not recommended that you do this if your course is live.
It is not recommended that you do this if your course is live.

#. Open the course in Studio.
#. On the **Settings** menu, select **Advanced Settings**.
Expand All @@ -69,7 +67,7 @@ To change the way that your course number appears in Studio and the LMS, follow
these steps.

.. note::
EdX does not recommended that you do this if your course is live.
It is not recommended that you do this if your course is live.

#. Open the course in Studio.
#. On the **Settings** menu, select **Advanced Settings**.
Expand All @@ -81,3 +79,19 @@ In Studio and the LMS, your course number changes to the value that you specify
in the **Course Number Display String** field. The URL for your course does not
change.


.. seealso::
:class: dropdown

:ref:`Getting Started with Course Content Development` (reference)

:ref:`Course Outline` (concept)

:ref:`Create a Course` (how-to)

:ref:`Create the Course About Page` (how-to)

:ref:`Understanding a Course Outline <Understanding Your Course Outline>` (reference)

:ref:`Developing Your Course Outline` (reference)

Loading

0 comments on commit 42d8ccb

Please sign in to comment.