Skip to content

Commit

Permalink
Migrate Legacy edX Educator Docs
Browse files Browse the repository at this point in the history
* Assimilate Legacy edX docs 

* Move remaining WIP Migration docs to an orphan page

---------

Co-authored-by: Shannon Rushe <[email protected]>
  • Loading branch information
jswope00 and srushe1 authored Oct 4, 2024
1 parent e980d1e commit bdf2708
Show file tree
Hide file tree
Showing 426 changed files with 9,457 additions and 9,732 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ build
source/.DS_Store
.idea/
sphinx-env/
venv/
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
11 changes: 11 additions & 0 deletions source/_tags/tagsindex.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
:orphan:

.. _tagoverview:

Tags overview
#############

.. toctree::
:caption: Tags
:maxdepth: 1

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. :diataxis-type: reference
.. :diataxis-type: how-to
***********************
The Open edX Site
***********************
*************************************************
Receive Open edX Platform Announcements by Email
*************************************************

The `Open edX Portal`_ is the destination for learning about hosting an Open
edX instance, extending the Open edX platform, and contributing to the Open edX project. In
Expand All @@ -12,10 +12,6 @@ community resources.
All users can view content on the Open edX site without creating an account
and logging in.

===============================
Release Announcements by Email
===============================

To receive and share product and release announcements by email, you can
subscribe to announcements on one of the edX portal sites.

Expand All @@ -30,4 +26,4 @@ subscribe to announcements on one of the edX portal sites.
You will now receive email messages when new announcements of the types you
selected are posted.

.. include:: ../links/links.rst
.. include:: ../../educators/migration_wip/links/links.rst
1 change: 1 addition & 0 deletions source/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ Community Home

release_notes/index
security_policy/index
how-tos/receive_announcements_by_email
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
.. :diataxis-type: concept
.. _edX Accessibility Guidelines:

===============================================================
What Is The edX Accessibility Best Practices Guidance Based On?
===============================================================

.. note:: This content has been migrated from legacy edx.org docs and has not yet been adjusted for the Open edX® Community

edX measures and evaluates accessibility primarily using the World Wide Web Consortium's
`Web Content Accessibility Guidelines (WCAG) 2.1 <https://www.w3.org/TR/WCAG/>`_
(05 June 2018). All features that are merged into edX repositories are
Expand Down Expand Up @@ -37,4 +41,12 @@ support. These trained professionals typically provide the following services, w
For more information, see the following topics.

* :ref:`Supporting Learners with Diverse Needs`
* :ref:`Accessibility Best Practices for Course Content Development`
* :ref:`Accessibility Best Practices for Course Content Development`

.. seealso::
:class: dropdown

:ref:`Accessibility Best Practices for Course Content Development` (concept)
:ref:`Designing for Mobile` (concept)
:ref:`Supporting Learners with Diverse Needs` (concept)
:ref:`Accessibility Checker` (reference)
Original file line number Diff line number Diff line change
Expand Up @@ -1052,4 +1052,12 @@ guidelines.
Universal Design for Learning Resources
=======================================

* `The National Center on Universal Design for Learning <https://udlguidelines.cast.org/>`_ provides a helpful overview on Universal Design for Learning.
* `The National Center on Universal Design for Learning <https://udlguidelines.cast.org/>`_ provides a helpful overview on Universal Design for Learning.

.. seealso::
:class: dropdown

:ref:`edX Accessibility Guidelines` (concept)
:ref:`Designing for Mobile` (concept)
:ref:`Supporting Learners with Diverse Needs` (concept)
:ref:`Accessibility Checker` (reference)
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
.. :diataxis-type: reference
.. :diataxis-type: concept
.. _Designing for Mobile:

###############################################
Designing Your Course For a Mobile Experience
###############################################

Keep in
mind that the courses and course content that you create should be accessible
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>`.

The percentage of learners who access MOOCs using smartphones is increasing
every day. Most courses on edx.org can be viewed on smartphones using the edX
Android and iPhone apps, although we still recommend that learners complete
Expand Down Expand Up @@ -87,4 +98,12 @@ renders as you expect it to.

.. note:: Keep in mind that course updates that you make might not be
immediately reflected in the edX mobile apps. In particular, newly
published content can take up to an hour to update on the Android app.
published content can take up to an hour to update on the Android app.

.. seealso::
:class: dropdown

:ref:`Accessibility Best Practices for Course Content Development` (concept)
:ref:`edX Accessibility Guidelines` (concept)
:ref:`Supporting Learners with Diverse Needs` (concept)
:ref:`Accessibility Checker` (reference)
24 changes: 24 additions & 0 deletions source/educators/concepts/accessibility/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _Accessibility:

#############################
Accessibility
#############################

Courses and course content developed on our platform should be accessible to
everyone, regardless of any physical limitation that they might have.

The topics in this section are intended to help course teams understand how to
develop courses that can serve the widest possible audience.

.. note:: Course teams should familiarize themselves with this best practices
guidance and distribute it to any members of their teams who are
responsible for creating course content.

.. toctree::
:maxdepth: 1
:glob:

best_practices_course_content_dev
supporting_learners_diverse_needs
accessibility_guidelines
design_for_mobile
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,12 @@ from supporting on-campus students, we encourage you to develop a plan to
respond to students who inform you of accessibility barriers to learning.
However, given the large numbers of learners enrolling in many of the courses,
you will quickly see how important it is to address accessibility concerns
when creating a course.
when creating a course.

.. seealso::
:class: dropdown

:ref:`Accessibility Best Practices for Course Content Development` (concept)
:ref:`edX Accessibility Guidelines` (concept)
:ref:`Designing for Mobile` (concept)
:ref:`Accessibility Checker` (reference)
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. :diataxis-type: concept
.. _Cohorts Overview:

#############################
Expand Down Expand Up @@ -263,7 +265,7 @@ discussion posts. If you want learners to see a different name for the default
cohort, you can change its name. For details about renaming cohorts, see
:ref:`Renaming a Cohort`.

.. image:: ../../images/post_visible_default.png
.. image:: /_images/educator_concepts/post_visible_default.png
:alt: A discussion topic post with "This post is visible to Default Group"
above the title.
:width: 600
Expand All @@ -277,3 +279,13 @@ previously saw will seem to have "disappeared". To avoid negatively affecting
the learner experience, any cohort assignment changes should be done as early
in the course run as possible, so that learners' views of discussion posts and
contributions remain consistent over time.

.. seealso::
:class: dropdown

:ref:`Manage Course Cohorts` (how-to)
:ref:`Create Cohort Specific Course Content` (how-to)
:ref:`About Divided Discussions` (concept)
:ref:`Managing Divided Discussion Topics` (concept)
:ref:`Moderating_discussions` (concept)
:ref:`Setting Up Divided Discussions` (how-to)
Original file line number Diff line number Diff line change
@@ -1,21 +1,11 @@
.. :diataxis-type: concept
.. _Overview of Content Experiments:

#################################
Overview of Content Experiments
#################################

This section provides an introduction to using content experiments.

.. contents::
:local:
:depth: 1

For more information, see :ref:`Configure Your Course for Content Experiments`
and :ref:`Add Content Experiments to Your Course`.

*********
Overview
*********

You use content experiments to show different course content to different
groups of learners. Also known as "A/B tests" or "split tests", content
Expand All @@ -28,6 +18,9 @@ from the instructor dashboard includes a column identifying the experiment
group that each learner has been assigned to. For more information, see
:ref:`Interpret the Grade Report`.

For more information, see :ref:`Configure Your Course for Content Experiments`
and :ref:`Add Content Experiments to Your Course`.

For information about analyzing events from content experiments, see
:ref:`AB_Event_Types` in the *EdX Research Guide*.

Expand Down Expand Up @@ -60,8 +53,8 @@ experiment to be independent and use a different grouping.

To determine the available groupings of learners, you set up group
configurations :ref:`using Studio <Set up Group Configurations in edX Studio>`
or :doc:`subsection_content_experiments_policies`.
or :ref:`Set Up Group Configuration for OLX Courses`.

You then select which group configuration to use when you add a content
experiment :ref:`using Studio <Add a Content Experiment in Studio>` or
:doc:`subsection_content_experiments_OLX`.
:ref:`Add a Content Experiment in OLX`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. :diataxis-type: concept
.. _Overview of Group Configurations:

****************************************
Overview of Group Configurations
****************************************

Before you can create :ref:`content experiments<Overview of Content
Experiments>`, you must specify at least one group configuration for your
course.

A group configuration defines how many groups of learners are in an experiment.
You can have any number of group configurations in your course. When you create
a content experiment, you select the group configuration to use.

For example, you might want to run two different content experiments at
different times during your course. In one content experiment, learners either
see a video or complete a reading assignment. You can then include problems so
that you can see which group learned the material more completely. For this
content experiment, you need a group configuration that assigns your learners
to two experiment groups.

In the other content experiment, you can present the same question using four
different types of problems. For this content experiment, you need a
group configuration that assigns your learners to four experiment groups.

.. seealso::
:class: dropdown

:ref:`Offering Differentiated Content` (concept)
:ref:`Configure Your Course for Content Experiments` (how-to)
:ref:`Experiment Group Configurations` (reference)
:ref:`Add a Content Experiment in OLX` (how-to)
:ref:`Set Up Group Configuration for OLX Courses` (how-to)
:ref:`Guidelines for Modifying Group Configurations` (concept)
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
.. :diataxis-type: concept
.. Section is shared in CA and OLX guides
.. _Guidelines for Modifying Group Configurations:

*********************************************
Guidelines for Modifying Group Configurations
Expand Down Expand Up @@ -46,3 +48,14 @@ the problems in the experiment group content to which they are reassigned.
Removing an experiment group affects event data for the course. Ensure that
researchers who are evaluating your course results are aware of the experiment
group that you removed and the date on which you removed it.


.. seealso::
:class: dropdown

:ref:`Offering Differentiated Content` (concept)
:ref:`Overview of Content Experiments` (concept)
:ref:`Configure Your Course for Content Experiments` (how-to)
:ref:`Experiment Group Configurations` (reference)
:ref:`Add a Content Experiment in OLX` (how-to)
:ref:`Set Up Group Configuration for OLX Courses` (how-to)
9 changes: 9 additions & 0 deletions source/educators/concepts/advanced_features/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#############################
Advanced Features
#############################

.. toctree::
:maxdepth: 1
:glob:

*
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. :diataxis-type: concept
.. _Offering Differentiated Content:

#######################################################
Expand Down Expand Up @@ -65,3 +67,8 @@ customized course experience.
For information about creating differentiated content using cohorts, see
:ref:`Cohorts Overview` and :ref:`Cohorted Courseware Overview`.

.. seealso::
:class: dropdown

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

Loading

0 comments on commit bdf2708

Please sign in to comment.