Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jswope00/see also links #757

Merged
merged 124 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
124 commits
Select commit Hold shift + click to select a range
1d7974f
Test change by removing a line break
leiramagpantay Nov 22, 2024
8cd59c3
Heading to changed into heading 1
leiramagpantay Nov 25, 2024
3eeda6f
Corrected heading code
leiramagpantay Nov 28, 2024
2cf68c3
Moved up in paragraph in one line. Changed the header.
leiramagpantay Nov 28, 2024
ee8489e
Changed heading 2 to heading 1. Corrected ssigned to assigned
leiramagpantay Nov 28, 2024
196fe6e
Changed heading 2 to heading 1.
leiramagpantay Dec 2, 2024
42d7859
Moved up in paragraph in one line. Changed the headings appropriately.
leiramagpantay Dec 2, 2024
6ce5680
Fixed heading.
leiramagpantay Dec 2, 2024
43b16f8
Changed heading.
leiramagpantay Dec 2, 2024
e16ad9f
Moved up in paragraph in one line. Change heading.
leiramagpantay Dec 2, 2024
58ab130
Change heading.
leiramagpantay Dec 2, 2024
dbf3aab
Fixed headings.
leiramagpantay Dec 3, 2024
9c32d8d
Changed headings.
leiramagpantay Dec 3, 2024
90c14a5
Changed headings.
leiramagpantay Dec 3, 2024
ed2b04b
Changed headings.
leiramagpantay Dec 3, 2024
4067b0e
Changed headings.
leiramagpantay Dec 3, 2024
bafca88
Changed headings.
leiramagpantay Dec 3, 2024
d533155
Changed headings.
leiramagpantay Dec 3, 2024
28a686f
Changed headings.
leiramagpantay Dec 3, 2024
3e70490
Moved up in paragraph in one line.
leiramagpantay Dec 4, 2024
84455fb
Moved up in paragraph in one line.
leiramagpantay Dec 4, 2024
2553bd4
Moved up in paragraph in one line.
leiramagpantay Dec 4, 2024
4885ca5
Changed headings.
leiramagpantay Dec 4, 2024
13dcdd0
Moved up in paragraph in one line.
leiramagpantay Dec 4, 2024
0f8452d
Moved up in paragraph in one line.
leiramagpantay Dec 4, 2024
bedb703
Moved up in paragraph in one line.
leiramagpantay Dec 4, 2024
3980684
Moved up in paragraph in one line.
leiramagpantay Dec 5, 2024
09d0990
Changed headings.
leiramagpantay Dec 5, 2024
67fc88b
Change heading.
leiramagpantay Dec 5, 2024
67da0a9
Changed headings.
leiramagpantay Dec 5, 2024
309d6a4
Changed headings.
leiramagpantay Dec 5, 2024
3e6887f
Changed headings.
leiramagpantay Dec 5, 2024
9d48bd3
Change heading.
leiramagpantay Dec 5, 2024
83092ab
Change heading.
leiramagpantay Dec 5, 2024
94e7a9a
See Also Links for Video
jswope00 Dec 5, 2024
50a47da
Merge branch 'main' of https://github.com/jswope00/docs.openedx.org
jswope00 Dec 6, 2024
ee654c3
Docs clean up add see also tables
srushe1 Dec 6, 2024
a263082
Merge remote-tracking branch 'origin/main'
srushe1 Dec 6, 2024
ca0e044
Update component and activity navigation
srushe1 Dec 6, 2024
1ec978e
edit editor for rst formatting
srushe1 Dec 6, 2024
0f5bc51
add see also table
srushe1 Dec 6, 2024
ab6216f
edit to remove edx reference
srushe1 Dec 6, 2024
b181fb7
Change heading.
leiramagpantay Dec 6, 2024
2e81ffd
Corrected spelling.
leiramagpantay Dec 6, 2024
e0a1055
Changed headings.
leiramagpantay Dec 6, 2024
341870b
Changed headings.
leiramagpantay Dec 6, 2024
6d6e3be
Change heading.
leiramagpantay Dec 6, 2024
6aa0a8e
Change heading.
leiramagpantay Dec 6, 2024
d784f00
Change heading.
leiramagpantay Dec 6, 2024
3c4df15
Changed headings.
leiramagpantay Dec 6, 2024
d8b08b0
Corrected spelling.
leiramagpantay Dec 6, 2024
e1ad89d
Corrected spellings.
leiramagpantay Dec 6, 2024
9738b67
Corrected spellings.
leiramagpantay Dec 6, 2024
0a88384
Corrected spellings.
leiramagpantay Dec 6, 2024
2aeead6
Corrected spellings.
leiramagpantay Dec 6, 2024
dd2c3fb
Add see also to Control Content Visibility & Access section
srushe1 Dec 9, 2024
bb00651
Add see also to Written content
srushe1 Dec 9, 2024
0918271
edited rst header
srushe1 Dec 9, 2024
a361fa1
Add see also to copy and paste content and unit pages
srushe1 Dec 9, 2024
e35b0af
Add see also to hide units and set restrictions
srushe1 Dec 9, 2024
e9f7097
Add see also to importing SCORM
srushe1 Dec 9, 2024
94b9a2f
Remove references to edx in beta testing
srushe1 Dec 9, 2024
3b165b1
Add see also to Add an image
srushe1 Dec 9, 2024
e40360f
Add tag and rst header to create course about page
srushe1 Dec 9, 2024
fb61224
Ass see also to describe course
srushe1 Dec 9, 2024
39fa0aa
Ass see all to licensing course
srushe1 Dec 9, 2024
e6a552c
Add tag and rst header
srushe1 Dec 9, 2024
5b7e7ab
Add see also to course staff
srushe1 Dec 9, 2024
2b60159
Add see also, edit references to edx
srushe1 Dec 9, 2024
e71da70
Add see also to grade report and progress pages
srushe1 Dec 9, 2024
3bb5529
Edit see also table learner data
srushe1 Dec 9, 2024
59bc986
Edit see also table certificate report columns
srushe1 Dec 9, 2024
991c25c
Add see also to entrance exam
srushe1 Dec 9, 2024
420e0b4
Add see also to prerequisites
srushe1 Dec 9, 2024
9b7bde8
Add tag and rst header
srushe1 Dec 9, 2024
2f926cc
Edit tags course rerun and add see also
srushe1 Dec 9, 2024
641d56d
Merge remote-tracking branch 'origin/main'
leiramagpantay Dec 9, 2024
d18d64e
Merge remote-tracking branch 'origin/main'
srushe1 Dec 9, 2024
f695ac7
Error in make html removing changes - to be edited again
srushe1 Dec 9, 2024
9a0389e
Add see also tables to certificate pages
srushe1 Dec 9, 2024
ccf13c3
Add see also table
srushe1 Dec 9, 2024
3590f75
Add tags and see also tables to ID concepts
srushe1 Dec 9, 2024
68751a2
Add see also tables to course run information pages
srushe1 Dec 9, 2024
182670c
Add see also tables to course pacing, course schedule, course dates; …
srushe1 Dec 9, 2024
6a75d5f
Add see also and format
srushe1 Dec 9, 2024
12d0c9b
Merge remote-tracking branch 'upstream/main'
jswope00 Dec 9, 2024
e7f8fff
See also table edits and formatting
srushe1 Dec 11, 2024
9354d08
Merge remote-tracking branch 'origin/main'
srushe1 Dec 11, 2024
128ef3f
Merge remote-tracking branch 'upstream/main'
jswope00 Dec 11, 2024
d9b4670
Resolve conflict in resources_for_course_teams.rst
jswope00 Dec 11, 2024
3fa3d9d
Edit see also tables to fix errors
srushe1 Dec 11, 2024
93466b0
Edit to remove references to edx/only edx.
srushe1 Dec 11, 2024
1a83b14
Edit to remove references to edx/only edx
srushe1 Dec 11, 2024
515254a
Edit to fix broken link
srushe1 Dec 11, 2024
ca774bd
Edit to remove references to edx/only edx
srushe1 Dec 11, 2024
49fb800
Edit to fix broken link
srushe1 Dec 11, 2024
7e8b591
Edit header
srushe1 Dec 11, 2024
37080be
Add see also table
srushe1 Dec 11, 2024
69de93d
Add see also table
srushe1 Dec 11, 2024
d030190
Edit to fix broken link
srushe1 Dec 11, 2024
abe7fd7
Edit to add see also table
srushe1 Dec 11, 2024
0f78465
Add see also table
srushe1 Dec 11, 2024
3bf7fbd
Edit to fix broken links
srushe1 Dec 11, 2024
23cfb2f
Edit to remove references to edx/only edx
srushe1 Dec 11, 2024
b84f4de
Edit to fix broken link
srushe1 Dec 11, 2024
bc15113
Edit to remove references to edx/only edx and edx mobile apps
srushe1 Dec 11, 2024
d772691
Merge remote-tracking branch 'origin/main'
jswope00 Dec 11, 2024
9a37fb0
Merge remote-tracking branch 'upstream/main'
jswope00 Dec 11, 2024
e5ab605
Fix reference to Open edX
jswope00 Dec 11, 2024
e1bac93
Fix reference to Open edX
jswope00 Dec 11, 2024
2e5f1bf
Change reference to Open edX
jswope00 Dec 11, 2024
accf425
Abstract several direct references to Open edX
jswope00 Dec 11, 2024
f154b9f
Apply suggestions from code review
jswope00 Dec 16, 2024
eba68aa
Replace some more challenging edX references, including references in…
jswope00 Dec 16, 2024
70529c2
Additional replacements of legacy edX references
jswope00 Dec 16, 2024
c90dd8d
Fix external links to legacy references
jswope00 Dec 16, 2024
89df2b3
Merge remote-tracking branch 'origin/main' into jswope00/replace_chal…
jswope00 Dec 16, 2024
d81fd73
Resolve See Also formatting
jswope00 Dec 16, 2024
fcb2d7c
See also spacing issue
jswope00 Dec 16, 2024
353117a
Merge reusable stub file rerun_course into course_rerun file
jswope00 Dec 16, 2024
1aff549
Validate information in the student profile report and remove legacy …
jswope00 Dec 16, 2024
2a5a4d3
Merge branch 'jswope00/student_profile_report'
jswope00 Dec 16, 2024
fcf9ec1
Merge branch 'jswope00/replace_challenging_edx_references'
jswope00 Dec 16, 2024
fbd2b87
Merge remote-tracking branch 'upstream/main' into 'jswope00/see_also_…
jswope00 Jan 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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