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/change external refs to internal #759

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 0 additions & 8 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,14 +104,6 @@
"event-routing-backends": (
f"https://event-routing-backends.readthedocs.io/{rtd_language}/{rtd_version}", None
),
"edx-installing-configuring-and-running": (
f"https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/{rtd_language}/{rtd_version}",
None,
),
"openedx-building-and-running-a-course": (
f"https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/{rtd_language}/{rtd_version}",
None,
),
"edx-platform": (
f"https://docs.openedx.org/projects/edx-platform/{rtd_language}/{rtd_version}",
None,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ ways to extend the platform, starting with the following table.
- Yes
* - Clean UI Integration
- Yes
- No (see :doc:`openedx-building-and-running-a-course:exercises_tools/lti_component`)
- No (see :ref:`LTI Component`)
- Yes
- Yes
- Yes
Expand All @@ -72,13 +72,13 @@ ways to extend the platform, starting with the following table.
- Yes
- Yes
* - Server Side Grading
- Possibly (See :doc:`openedx-building-and-running-a-course:exercises_tools/custom_javascript`)
- Possibly (See :ref:`Custom JavaScript`)
- Yes
- Yes
- Yes
- Yes
* - Usage Data
- No (See :doc:`openedx-building-and-running-a-course:exercises_tools/custom_javascript`)
- No (See :ref:`Custom JavaScript`)
- No
- Limited
- Yes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ other course content component, or for sequential or vertical course container
component. There are several ways to find the ``usage_id`` for an XBlock in the
LMS, including viewing either the staff debug info or the page source. For more
information, see
:doc:`openedx-building-and-running-a-course:course_features/lti/lti_address_content`.
:ref:`Determine Content Addresses`.


Example XBlock URLs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ to everyone, regardless of any physical limitation that they might have, and
regardless whether they are accessing your course using a Web browser or using
mobile apps.

For information about accessibility best practices, see :ref:`Accessibility
Index <Accessibility Index>`.
For information about accessibility best practices, see :ref:`Accessibility Best Practices for Course Content Development`.

The percentage of learners who access MOOCs using smartphones is increasing
every day. Courses on your instance may be viewed on smartphones using the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ content in the context of an external LMS.
:depth: 1

For information about the content that you can include in an external LMS, see
:ref:`Preparing Content`.
:ref:`Planning for Content Reuse`.

**********************************
Course Roster Management
Expand Down Expand Up @@ -74,7 +74,7 @@ example, edX course discussions can identify participants by their edX IDs
instead of the usernames they would normally see in the external LMS. As a
result, some edX content is not currently suitable for use in an external LMS.

For more information, see :ref:`Preparing Content`.
For more information, see :ref:`Planning for Content Reuse`.

******************************
Learner Progress and Grades
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,14 @@ If you have enabled cohorts in your course, you can associate one or more cohort
For example, you might intend all learners in your course to have substantially the same course experience, except that you want to show learners who are either current students or alumni of your institution a special video in several sections. You already have your institution's current students in one cohort and alumni in another cohort. By associating both of
these cohorts with the same content group, and restricting access to the special institutional-related video to only this content group, you can provide a customized course experience.

For information about creating differentiated content using cohorts, see :ref:`Cohorts Overview` and :ref:`Cohorted Courseware Overview`.
For information about creating differentiated content using cohorts, see :ref:`Cohorts Overview`.

.. seealso::

:ref:`Enrollment Track Specific Courseware Overview` (how-to)

:ref:`Cohorts Overview` (concept)

:ref:`Cohorted Courseware Overview` (concept)

:ref:`About Content Groups` (concept)

:ref:`Overview of Content Experiments` (concept)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Learner's Experience of Teams

.. tags:: educator, concept

After you have :ref:`enabled teams <Teams Setup>` and created topics in your
After you have :ref:`enabled teams <Enable and Configure Teams>` and created topics in your
course, learners can begin browsing topics and joining teams. Teams are formed
within topics. Each learner can belong to only one team.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ requirements.
a learner and not a TA or course designer.

For more information about constructing an LTI URL for a course component, see
:ref:`Determining Content Addresses`.
:ref:`Determine Content Addresses`.

.. seealso::
:class: dropdown
Expand All @@ -62,6 +62,6 @@ For more information about constructing an LTI URL for a course component, see

:ref:`Planning for Content Reuse (LTI)<Planning for Content Reuse>` (reference)

:ref:`Example: edX as an LTI Provider to Canvas<edX as an LTI Provider to Canvas>` (reference)
:ref:`Example: Open edX as an LTI Provider to Canvas<Open edX as an LTI Provider to Canvas>` (reference)

:ref:`Example: edX as an LTI Provider to Blackboard<edX as an LTI Provider to Blackboard>` (reference)
:ref:`Example: edX as an LTI Provider to Blackboard<Open edX as an LTI Provider to Blackboard>` (reference)
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ assessment) to complete the assignment.
an open response assessment divided by cohort, you must create that
assessment in a course component that is defined as cohort-specific. For more
information about cohorts and creating cohort-specific course content, see
:ref:`Cohorts Overview <cohorts overview>` and :ref:`Cohorted Courseware Overview <cohorted courseware overview>`.
:ref:`Cohorts Overview <cohorts overview>` and :ref:`Offering Differentiated Content to Different Learner Groups <Offering Differentiated Content>`.

The following topics provide conceptual information about open response
assessments.
Expand Down Expand Up @@ -374,7 +374,7 @@ steps, and make it available only to the members of one or more specific
cohorts. For the members of the remaining cohorts, you create an ORA assignment
that has only the peer assessment step. For details about creating different
course experiences for learners in different cohorts, see
:ref:`Cohorted Courseware Overview <cohorted courseware overview>`.
:ref:`Create Cohort Specific Course Content <cohorts overview>`.

For details about performing grading in staff assessment steps, see
:ref:`Perform a Staff Assessment`.
Expand Down Expand Up @@ -710,8 +710,7 @@ change.

This set of file name extensions is provided as the default for Open edX
installations. Open edX system administrators can update this list. For more
information, see
:ref:`Configuring ORA2 to Prohibit Submission of File Types <configuring ora2 to prohibit submission of file types>`.
information, see `Configuring ora2 to prohibit submission of file types`_.

.. list-table::
:widths: 15 75
Expand Down
2 changes: 2 additions & 0 deletions source/educators/concepts/grading/graded_subsections.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Graded Subsections:

##################
Graded Subsections
##################
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ The numbers represent the following levels.
#. :ref:`Units<Developing Course Units>`

.. note::
The **Course Outline** page does not show :ref:`components<Developing
Course Components>`. You add or access components by selecting the units
The **Course Outline** page does not show :ref:`components<What is a Component>`. You add or access components by selecting the units
that contain the components.

===========================
Expand All @@ -42,5 +41,4 @@ If a learner selects the **Resume Course** option, the course opens to the
unit that the learner most recently completed.

For information about more specific learner data, including the learner's
grades or answers for individual problems, see :ref:`Manage Student Progress
Index`.
grades or answers for individual problems, see :ref:`Learner Data`.
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ outline, see the section on :ref:`Creating a Course in Open edX® <Creating Cour

:ref:`Additional Course Information` (reference)

:ref:`Creating a New Course <Create a New Course>`
:ref:`Creating a New Course <Create a New Course>`
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ To prepare learners for a proctored exam, follow these guidelines:
* Explain what proctored exams are, and provide learners with links to the
`OE SFD Proctored Exams`_ topic in the *Open edX
Learner’s Guide*.
* Communicate the rules for proctored exams, including the :ref:`online
proctoring rules<CA Online Proctoring Rules>` in the *Open edX Learner’s
* Communicate the rules for proctored exams, including the :ref:`Online Proctoring Rules` in the *Open edX Learner’s
Guide* as well as any specific rules for a particular exam. For information
about creating specific rules, see
:ref:`specifying_exam_rules_and_exceptions`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Proctored exams are timed exams that learners take while online proctoring
software monitors their computer, environment, and behavior. When learners
complete a proctored exam, the recording of the exam is examined to
determine whether the learner complied with the :ref:`online proctoring rules
<CA Online Proctoring Rules>`.
<Online Proctoring Rules>`.

Learners must be in the verified enrollment track to take a proctored exam.

Expand Down
2 changes: 1 addition & 1 deletion source/educators/how-tos/add_course_creators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ For a step-by-step to grant staff permissions to courses, check out this video:

:ref: `Add Beta Testers to a CourseAdd Beta Testers to a CourseAdd Beta Testers to a Course` (how-to)

:ref: `Add Course Team Members` (how-to)
:ref: `Add Course Staff` (how-to)

:ref: `Planning Course Staff` (reference)

2 changes: 2 additions & 0 deletions source/educators/how-tos/add_video_quiz.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ It's possible to add quizzes directly to a video! Watch this for a how-to:

:ref:`Troubleshoot Videos` (reference)

:ref:`Video Guidelines` (reference)

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

:ref:`Specifying Additional Video Options <Additional Video Options>` (how-to)
2 changes: 1 addition & 1 deletion source/educators/how-tos/advanced_features/add_cohorts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ add a cohort to your course, follow these steps.
#. Optionally, select **Select a Content Group** to associate the cohort with a
:ref:`content group<About Content Groups>`. For information about creating
cohort-specific course content by associating cohorts with content groups,
see :ref:`Cohorted Courseware Overview`.
see :ref:`Cohorts Overview` and :ref:`Offering Differentiated Content`.

#. Select **Save**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ cohorts.
Overview
*********

If you have :ref:`Enable Cohorts` in your
If you have :ref:`enabled cohorts<Manage Course Cohorts>` in your
course, you can create different course experiences for learners in different
cohorts.

Expand All @@ -36,7 +36,7 @@ Complete these steps to create cohort-specific content in your course.

In Studio

#. :ref:`Enable cohorts in your course<Enabling and Configuring Cohorts>`.
#. :ref:`Enable cohorts in your course<Manage Course Cohorts>`.
#. :ref:`Create content groups<Creating Content Groups>`.
#. :ref:`Specify components or units as available only to particular content
groups<Specify Content as Available Only to Certain Content Groups>`.
Expand All @@ -61,7 +61,7 @@ University Alumni and Current University Students. Learners who are not in
either of these cohorts are automatically placed into a third cohort, the
default cohort, when they access the **Course** or **Discussion** tabs in the
course. For more information about enabling cohorts in your course and
assigning students to cohorts, see :ref:`Enabling and Configuring Cohorts`.
assigning students to cohorts, see :ref:`Manage Course Cohorts`.

You intend all learners to have substantially the same course experience, with
the exception that only learners in the two university-related cohorts will
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ To enable content experiments in your course, you must add ``split_test`` to the

.. _Enable Content Experiments:

*********************************
Enable Content Experiments
*********************************

#. From the **Settings** menu, select **Advanced Settings**.

#. On the **Advanced Settings** page, locate **Advanced Module List**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ completed the following tasks.
The content experiment includes a container for each group that is defined
in the group configuration you selected. You create content for each
experiment group as you do any other component. For more information, see
:ref:`Developing Course Components`.
:ref:`Add a Component`.

#. Select either **Select a Group Configuration** or **Edit** to open the
content experiment component.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To use Open edX course content in the Blackboard LMS, you add a new app to the c
:alt: The Blackboard Create Web Link page with example name and URL
values.

For more information, see :ref:`Determining Content Addresses`.
For more information, see :ref:`Determine Content Addresses`.

#. Review the content to verify that it appears as you expect.

Expand All @@ -54,4 +54,4 @@ To use Open edX course content in the Blackboard LMS, you add a new app to the c

:ref:`Planning for Content Reuse (LTI)<Planning for Content Reuse>` (reference)

:ref:`Example: edX as an LTI Provider to Canvas<edX as an LTI Provider to Canvas>` (reference)
:ref:`Example: Open edX as an LTI Provider to Canvas<Open edX as an LTI Provider to Canvas>` (reference)
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To use Open edX course content in the Canvas LMS, you add a new app to the cours
:alt: The Canvas page where you add an external tool and supply the LTI
URL.

For more information, see :ref:`Determining Content Addresses`.
For more information, see :ref:`Determine Content Addresses`.

#. Review the content to verify that it appears as you expect.

Expand All @@ -45,4 +45,4 @@ To use Open edX course content in the Canvas LMS, you add a new app to the cours

:ref:`Planning for Content Reuse (LTI)<Planning for Content Reuse>` (reference)

:ref:`Example: edX as an LTI Provider to Blackboard<edX as an LTI Provider to Blackboard>` (how-to)
:ref:`Example: edX as an LTI Provider to Blackboard<Open edX as an LTI Provider to Blackboard>` (how-to)
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,8 @@ LTI URLs for Text components include "html+block" or "html", as follows.

:ref:`Planning for Content Reuse (LTI)<Planning for Content Reuse>` (reference)

:ref:`Example: edX as an LTI Provider to Canvas<edX as an LTI Provider to Canvas>` (reference)
:ref:`Example: Open edX as an LTI Provider to Canvas<Open edX as an LTI Provider to Canvas>` (reference)

:ref:`Example: edX as an LTI Provider to Blackboard<edX as an LTI Provider to Blackboard>` (reference)
:ref:`Example: edX as an LTI Provider to Blackboard Provider <Open edX as an LTI Provider to Blackboard>` (reference)


Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ steps.

:ref:`Planning for Content Reuse (LTI)<Planning for Content Reuse>` (reference)

:ref:`Example: edX as an LTI Provider to Canvas<edX as an LTI Provider to Canvas>` (reference)
:ref:`Example: Open edX as an LTI Provider to Canvas<Open edX as an LTI Provider to Canvas>` (reference)

:ref:`Example: edX as an LTI Provider to Blackboard<edX as an LTI Provider to Blackboard>` (reference)
:ref:`Example: edX as an LTI Provider to Blackboard<Open edX as an LTI Provider to Blackboard>` (reference)
4 changes: 3 additions & 1 deletion source/educators/how-tos/advanced_features/timed_exams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Configure Timed Exams

.. tags:: educator, how-to

.. _Enable Timed Exams:

*******************
Enable Timed Exams
*******************
Expand Down Expand Up @@ -59,7 +61,7 @@ steps.

If your course has the proctored exam feature enabled, the
**Advanced** tab also shows options for :ref:`proctored and practice
proctored exams<CA_ProctoredExams>`.
proctored exams<ProctoredExams_Overview>`.

#. In the **Time Allotted** field, enter the length of time that you want
learners to have to complete the problems in the subsection. Enter the time
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,11 @@ Discussion list now includes the topic you added.
configure these topics to be divided by cohort. For more information, see
:ref:`Divide Course Wide Discussion Topics`.

.. _Enable Discussion on a Course Unit:

Upgraded Open edX Forum
=======================
**********************************
Enable Discussion on a Course Unit
**********************************

Discussion can be enabled for a course unit, which is equivalent to adding
a content-specific discussion topic in that unit in the :ref:`legacy version of
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ Setting Up Divided Discussions


By default, all :ref:`course-wide discussion topics<Create CourseWide
Discussion Topics>` and :ref:`content-specific discussion topics<Create
ContentSpecific Discussion Topics>` are unified: all learners can interact
Discussion Topics>` and :ref:`content-specific discussion topics<Content Specific Discussion Topics>` are unified: all learners can interact
with all posts, responses, and comments. You can change discussion topics of
either type to be divided or unified on the discussions configuration page
(see :ref:`Create CourseWide Discussion Topics`).
Expand All @@ -39,8 +38,7 @@ topics.
Divide All Content-Specific Discussion Topics
*********************************************

When you :ref:`create content-specific discussion topics<Create
ContentSpecific Discussion Topics>` by adding discussion components to units
When you :ref:`create content-specific discussion topics<Enable Discussion on a Course Unit>` by adding discussion components to units
in Studio, these discussion topics are by default unified. All learners in the
course can see and respond to posts from all other learners. You can change
content-specific discussion topics to be divided, so that only members of the
Expand Down
Loading