Skip to content

Commit

Permalink
FC-0068 docs: concepts review by edunext 15 (#761)
Browse files Browse the repository at this point in the history
* FC-0068 docs: concepts review by edunext 15

This PR modifies a series of concept documents migrated from the legacy repositories to the educators' documentation.

* Update configure-discussions.rst

* Update source/educators/concepts/communication/discussion_guidance_moderators.rst

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

* Update source/educators/concepts/communication/moderating_discussions.rst

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

* Update source/educators/concepts/communication/moderating_discussions.rst

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

* Update source/educators/concepts/open_edx_platform/what_is_course_dashboard.rst

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

* Update source/educators/concepts/open_edx_platform/what_is_course_dashboard.rst

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

* Update source/educators/concepts/open_edx_platform/what_is_profile_page.rst

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

* Update source/educators/how-tos/communication/configure-discussions.rst

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

* commit errors

* Apply suggestions from code review

---------

Co-authored-by: Sarina Canelake <[email protected]>
  • Loading branch information
Apgomeznext and sarina authored Jan 14, 2025
1 parent 86caf0a commit 8cf9c38
Show file tree
Hide file tree
Showing 15 changed files with 136 additions and 113 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _About Divided Discussions:

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

Expand All @@ -19,7 +18,6 @@ For more information about creating differentiated course content for learners
in different groups (cohorts), see :ref:`Offering Differentiated Content`.


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

Expand Down
25 changes: 12 additions & 13 deletions source/educators/concepts/communication/course_discussions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ About Course Discussions

.. tags:: educator, concept

Discussions in an edX course include both course-wide topics of interest to
Discussions in an Open 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.
Expand All @@ -31,30 +31,30 @@ 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
names are not visible. The recommendation is 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,
Topics>` that you create on the course 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
*********************************
Discussions in the Open 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
Learners can participate in course discussions using the Open edX mobile app of your instance as
they do on the website, 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.
The following actions are not supported on the Open edX mobile apps.

* Pinning posts
* Marking responses to question posts as answers
Expand All @@ -63,20 +63,19 @@ The following actions are not supported on the edX mobile apps.

.. _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`_.
the Open 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
Expand Down Expand Up @@ -104,4 +103,4 @@ topics, see :ref:`Visibility of Discussion Topics`.
.. seealso::
:class: dropdown

:ref:`Configuring Edx Discussions` (how-to)
:ref:`Configuring Open edX Discussions` (how-to)
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _Guidance for Discussion Moderators:

######################################
Guidance for Discussion Moderators
######################################

Expand All @@ -24,7 +23,6 @@ contributions of your discussion moderators.
:local:
:depth: 1

**********************
Responsibilities
**********************

Expand All @@ -50,7 +48,6 @@ Responsibilities

* Add helpful items to the FAQ or to a welcome message or course handout.

***************************************
Qualities of Good Discussion Moderators
***************************************

Expand All @@ -67,7 +64,7 @@ Qualities of Good Discussion Moderators

* Enthusiasm: this is the best predictor of moderator excellence!

******************************************

Best Practices for Discussion Moderation
******************************************

Expand All @@ -89,7 +86,7 @@ Best Practices for Discussion Moderation
* Develop a discussion persona. Try to answer your questions in your own
slightly unique way.

*******************************************

Guidelines for Specific Types of Posts
*******************************************

Expand Down Expand Up @@ -154,21 +151,18 @@ Bugs or Errors
platform.

You might say: “Thanks for letting us know about that issue. We
are working with edX to get it fixed as quickly as possible.”
are working to get it fixed as quickly as possible.”

============================
Feature Requests
============================

* Keep an organized collection of feature requests cultivated by the course
team. That list can subsequently be shared with an edX product manager, who
will log those requests internally.
* Consider keeping an organized collection of feature requests cultivated by the course team, to share with the Open edX community for potential future feature development.

* Reply to the post to let the person know that their request was heard,
without promising that the feature will be implemented.

You might say: "Thanks for your suggestion. I've logged it for review by edX
staff, who will prioritize feature requests on the development roadmap."
You might say: "Thanks for your suggestion. I've logged it for review by the Open edX Community, who will prioritize feature requests on the development roadmap."

* Search the discussions for other similar requests, and respond to and close
those as well.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _Managing Divided Discussion Topics:

###################################
Managing Divided Discussion Topics
###################################

Expand All @@ -21,7 +20,6 @@ Discussions`.
:local:
:depth: 1

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

Expand All @@ -31,11 +29,6 @@ particular group. For learners, this is the only noticeable difference between
discussions in courses that use divided discussions, and courses that do not
have groups and do not use divided discussions.

You can share the examples in the :ref:`Read the Group Indicator in Posts`
section with your learners. The `course discussions index`_
section in the *Open edX Learner's Guide* also provides useful information to
help learners make the most of their participation in course discussions.

Course team members who have the Discussion Admin, Discussion Moderator,
Community TA or Group Community TA role see the indicator of who can read each
post. Team members with these roles, except for Group Community TAs, can read
Expand Down Expand Up @@ -145,7 +138,7 @@ Community TA role can make posts to divided discussion topics visible to
everyone who is enrolled in the course or only to the members of a specified
group.

If you are a course team member with one of these roles, when you `add a post`_, the **Visible to** dropdown list appears above the **Title**
If you are a course team member with one of these roles, when you add a post, the **Visible to** dropdown list appears above the **Title**
field.

.. note:: Group Community TAs cannot choose the group visibility of a post.
Expand Down Expand Up @@ -228,4 +221,13 @@ you filter the list by a specific group, you see the same, complete set of
posts that the members of that group see.

For other options that you can use to view posts, see
:ref:`Moderating_discussions`.
:ref:`Moderating_discussions`.

.. seealso::
:class: dropdown

:ref:`Guidance for Discussion Moderators` (concept)

:ref:`Assigning_discussion_roles` (how-to)

:ref:`Administer Discussions` (how-to)
22 changes: 7 additions & 15 deletions source/educators/concepts/communication/moderating_discussions.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _Moderating_discussions:

#######################
Moderating Discussions
#######################

Expand All @@ -25,23 +24,21 @@ relay it back to the course team.
about discussion roles, see :ref:`About_discussion_roles`.

.. note:: Not all options for moderating discussions are available when
discussions are accessed using the edX mobile apps. For information about
the differences between discussions on the edx.org site and in the mobile
discussions are accessed using the Open edX mobile app. For information about
the differences between discussions on the desktop site and in the mobile
apps, see :ref:`Discussions on Mobile Apps`.

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

For information about best practices for moderating discussions, see
:ref:`Guidance for Discussion Moderators`. If you are using :ref:`divided
discussions`<About Divided Discussions>`, see :ref:`Managing Divided Discussion
:ref:`Guidance for Discussion Moderators`. If you are using `divided discussions <https://docs.openedx.org/en/latest/educators/concepts/communication/about_divided_discussions.html#about-divided-discussions>`_, see :ref:`Managing Divided Discussion
Topics`.


.. _About_discussion_roles:

*********************************
About Discussion Moderation Roles
*********************************

Expand All @@ -59,7 +56,6 @@ moderate discussions and work with posts, responses, and comments.
Admin role can grant discussion roles.


============================
The Discussion Roles
============================

Expand All @@ -68,9 +64,9 @@ the following roles.

.. note:: The options for moderating discussions described below are only
available when members of the discussion administration team work in a web
browser. The edX mobile apps do not currently offer moderation options.
browser. The Open edX mobile apps do not currently offer moderation options.

For more information about differences between discussions on the edx.org
For more information about differences between discussions on the desktop
site and on the mobile apps, see :ref:`Discussions on Mobile Apps`.

* Course team members with the Discussion Moderator role can edit and delete
Expand Down Expand Up @@ -114,17 +110,13 @@ Provide Guidelines for Learners
You can develop a set of best practices for discussion participation and make
them available to learners as a course handout file or on a defined page in
your course. These guidelines can define your expectations and optionally
introduce features of edX discussions.
introduce features of Open edX discussions.

You can also refer learners to the `course discussions index`_ section in the *Open EdX Learner's Guide*. Consider referring learners
in your courses to that section, which describes the structure and features of
edX course discussions, and provides useful information to help learners make
Open edX course discussions, and provides useful information to help learners make
the most of their participation in course discussions.

.. For a template that you can use to develop your own guidelines, see
.. :ref:`Discussion Forum Guidelines`.
.. _Develop a Positive Discussion Culture:

***************************************
Expand Down
14 changes: 3 additions & 11 deletions source/educators/concepts/communication/running_discussions.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _Running_discussions:

############################
Running Course Discussions
############################

Expand Down Expand Up @@ -46,13 +45,6 @@ The dialog created by a post, its responses, and the comments on those
responses is sometimes called a thread. Discussion threads are saved as part
of the course history.

For information about participating in discussions, see the
`course discussions index`_ section in the *Open edX
Learner's Guide*. Consider referring learners in your courses to that section,
which describes the structure and features of course discussions, and provides
useful information to help learners make the most of their participation in
course discussions.


************************************************
Using Naming Conventions for Discussion Topics
Expand Down Expand Up @@ -100,7 +92,7 @@ Some examples follow.
providing guidance, these initial messages can act as models for learners to
follow when they create their own posts.

EdX strongly recommends that you do not create seed posts in content-specific
It is strongly recommended that you do not create seed posts in content-specific
discussion topics before the course starts or before the containing unit is
released. The category and subcategory names for content-specific discussion
topics are subject to the release visibility of their containing unit, and are
Expand All @@ -120,7 +112,7 @@ discussion.

.. note:: You can only pin or close posts and mark questions as answered when
you work in a web browser. You cannot complete these activities when you
work in the edX mobile app.
work in the Open edX mobile app.

* Pin posts. Pinning a post makes it appear at the top of the list of posts in
the discussion navigation pane on the **Discussion** page. As a result, it is
Expand Down Expand Up @@ -199,6 +191,6 @@ units and all course-wide topics are affected.

:ref:`Discussions` (concept)

:ref:`Configuring Edx Discussions` (how-to)
:ref:`Configuring Open edX Discussions` (how-to)

:ref:`Closing Discussions` (how-to)
18 changes: 13 additions & 5 deletions source/educators/concepts/open_edx_platform/outline_studio_lms.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _Course Outline:

==================
Course Outline
==================
##############

.. tags:: educator, concept

Expand All @@ -24,9 +23,9 @@ The numbers represent the following levels.
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.

===========================

Course Progress Information
===========================
****************************

The course outline in the LMS also indicates a learner's progress through the
course. A green check mark next to the name of a section, subsection, or unit
Expand All @@ -41,4 +40,13 @@ 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:`Learner Data`.
grades or answers for individual problems, see :ref:`Nav Learner Data`.

.. seealso::
:class: dropdown

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

:ref:`Add Content in the Course Outline` (reference)

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

0 comments on commit 8cf9c38

Please sign in to comment.