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/assimilate legacy docs #561

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open
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.
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.
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this being added here?

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
@@ -0,0 +1,69 @@
.. :diataxis-type: concept

.. _About Divided Discussions:

###################################
About Divided Discussion Topics
###################################

This section provides information about setting up discussions that are
divided by learner groups (cohorts) within your course.

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

For overview information about discussions in a course, see :ref:`Discussions`.

For more information about creating differentiated course content for learners
in different groups (cohorts), see :ref:`Offering Differentiated Content`.


******************************
What Are Divided Discussions?
******************************

With divided discussions, discussion topics are visible to all learners, but
the posts, responses, and comments within these topics are divided so that
learners participate in the discussion only with other members of the same
group (cohort).

Discussion topics that are not divided are unified, meaning that all learners
in the course can see and respond to posts, responses, and comments from any
other learner in the course.

=======================================
Best Practices for Divided Discussions
=======================================

If you divide discussions, a good practice is to use a naming convention for
discussion topics, so that learners clearly understand the audience for a
discussion topic before they add posts to that topic. For information about
naming conventions, see :ref:`Apply Naming Conventions to Discussion Topics`.

You can also appoint learners as Community TAs or Group Commmunity
TAs to help you to moderate course discussions. You might use Group
Community TAs if the content of discussion topics by one group (cohort) should not be
shared with another group. Group Community TAs are themselves members of
learner groups (cohorts) that you use in your course. As discussion moderators, they can
only see and respond to posts by other members of their own group (cohort). For information,
see :ref:`Assigning_discussion_roles`.

For more information about managing discussions, see :ref:`Managing Divided
Discussion Topics` and :ref:`Running_discussions`.

.. note::

Another method of providing different discussion experiences for learners in
different groups in your course is to use the access settings of discussion
components. For example, you can add multiple discussion components and use
each component's access settings to restrict access to each discussion
component to a specific content group. You can then assign these content
groups to learner groups (cohorts). For more information,
see :ref:`Setting Up Divided Discussions`.

.. seealso::
:class: dropdown

:ref:`Setting Up Divided Discussions` (how-to)

107 changes: 107 additions & 0 deletions source/educators/concepts/communication/course_discussions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
.. :diataxis-type: concept

.. _Discussions:

About Course Discussions
###########################

Discussions in an edX course include both course-wide topics of interest to
all learners (such as "Feedback", "Troubleshooting", or "Technical Help") as
well as content-specific topics that you add to course units as discussion
components. You can create both types of discussion topics in Studio.

For information about creating discussion topics, see the following sections.

For information about creating discussions in which learners in a group (cohort)
only interact with posts from other learners in the same group,
see :ref:`About Divided Discussions`.

For information about running and moderating course discussions, see
:ref:`Running_discussions` and :ref:`Moderating_discussions`.

.. _Visibility of Discussion Topics:

Understanding When Learners Can See Discussion Topics
*****************************************************

The names that you specify as the category and subcategory names for discussion
components are not visible on the Discussion page in the LMS until after
the course has started and the unit is released.

However, "seed" posts that you create in content-specific discussion topics
before a course starts, or before the unit is released, are immediately visible
on the Discussion page, even though the containing category or subcategory
names are not visible. EdX recommends that you do not create posts in
content-specific discussion topics before a unit is released. For more
information about release dates and the visibility of components, see
:ref:`Controlling Content Visibility`.

In contrast, :ref:`course-wide discussion topics<Create CourseWide Discussion
Topics>` that you create on the edx discussions configuration page in Studio,
including the default "General" discussion topic, are immediately visible,
regardless of whether the course has started. They are not associated with any
particular section or subsection of the course, and are not subject to
release dates.

.. _Discussions on Mobile Apps:

Discussions in the edX Mobile App
*********************************

Learners can participate in course discussions using the edX mobile app as
they do on the edX site, but there are some differences in the actions that
moderators can take in discussions using the mobile app. To perform moderation
or administrative tasks for your course discussions, you need to work in a web
browser.

The following actions are not supported on the edX mobile apps.

* Pinning posts
* Marking responses to question posts as answers
* Endorsing responses to discussion posts
* Closing posts

.. _The Upgraded Discussion Forum:

*****************************************
The Upgraded Discussion Forum
*****************************************

Course runs created on or after May 16, 2023, use an upgraded version of
the edX discussion forum. Learn more about it `here`_.

.. _here: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3470655498/Discussions+upgrade+Sidebar+and+new+topic+structure.

.. _Content Specific Discussion Topics:

============================================
Content-specific Discussion Topics (Legacy)
============================================

To create a content-specific discussion topic, you add a discussion component
to a unit. Typically, you do this while you are designing and creating your
course in Studio. Follow the instructions in :ref:`Working with Discussion
Components`. The result is a discussion topic associated with a unit and its
content. Learners can access content-specific topics both in the course unit
and on the Discussion page.

.. warning:: Follow the recommended steps to add discussion components. Do not
create discussion topics by using the Duplicate button in Studio, and do
not reference the same discussion ID in more than one place in your course.
Duplicated discussion components result in discussion topics that contain the
same conversations, even if learners post in different discussion topics.

For information about the visibility of content-specific discussion
topics, see :ref:`Visibility of Discussion Topics`.

.. note:: In courses with cohorts enabled, when you add 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 same group can see and respond to each other's posts. For information,
see :ref:`Divide All Content Specific Discussion Topics`.

.. seealso::
:class: dropdown

:ref:`Configuring Edx Discussions` (how-to)
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. :diataxis-type: concept

.. _Guidance for Discussion Moderators:

######################################
Expand Down Expand Up @@ -170,3 +172,10 @@ Feature Requests

* Search the discussions for other similar requests, and respond to and close
those as well.

.. seealso::
:class: dropdown

:ref:`Guidance for Discussion Moderators` (concept)
:ref:`Assigning_discussion_roles` (how-to)
:ref:`Administer Discussions` (how-to)
9 changes: 9 additions & 0 deletions source/educators/concepts/communication/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#############################
Communication
#############################

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

*
Loading