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

FC-0068 docs: concept cleaning by edunext #11 #716

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 10 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
110 changes: 56 additions & 54 deletions source/educators/concepts/advanced_features/lti_reuse_content.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,29 @@
.. _Reusing Course Content:

##########################################
Reusing Course Content with LTI
##########################################
###############################

.. tags:: educator, concept

.. only:: Partners

.. note:: This feature was a closed pilot experiment. This feature is not
supported for new users.

When you use LTI to reuse edX course content, learners who are already familiar
with an external learning management system or other consumer application
(external LMS) see content from edX that is seamlessly integrated into a
familiar context. Only the content that you specify from edX appears in the
external LMS, typically within an iframe on a page.
When you use LTI to reuse your course content, learners who are already
familiar with an external learning management system or other consumer
application (external LMS) see content from your Open edX instance that is
seamlessly integrated into a familiar context. Only the content that you
specify from your Open edX instance appears in the external LMS, typically
within an iframe on a page.

For example, you can set up a course on an external LMS, such as Canvas, to
include a link to a problem component that is part of an edX course. The
problem is included as one of the course's assignments, and appears in Canvas
like other content.
include a link to a problem component that is part of a course on your
instance. The problem is included as one of the course's assignments, and
appears in Canvas like other content.

.. image:: /_images/educator_concepts/lti_canvas_example.png
:alt: An edX molecule builder problem shown as part of a course running on a
Canvas system.
:alt: An Open edX molecule builder problem shown as part of a course running
on a Canvas system.

This section provides background information on different aspects of the
experience that learners and course team members have when interacting with edX
content in the context of an external LMS.
experience that learners and course team members have when interacting with
Open edX content in the context of an external LMS.

.. contents::
:local:
Expand All @@ -37,56 +32,63 @@ content in the context of an external LMS.
For information about the content that you can include in an external LMS, see
:ref:`Preparing Content`.

**********************************
Course Roster Management
**********************************
************************

Course teams manage the course roster entirely on the external LMS, as you
would for other courses that run on that platform. Learners do not use the edX
LMS to enroll, and the course team does not complete any enrollment activities
in Studio or the edX LMS.
would for other courses that run on that platform. Learners do not use the Open
edX LMS to enroll, and the course team does not complete any enrollment
activities in Studio or the Open edX LMS.

To obtain enrollment data for the course, you use the features available in
the external LMS.

******************************************
Learner Identification and Single Sign On
******************************************

.. only:: Partners

.. note:: Different configuration options are available for how an external
LMS and edX Edge authenticate users. Your DevOps team is likely to have
additional information about the specific authentication process used by
your institution.
*****************************************

Learners do not need to navigate to a different website, or sign in to any
other system (including edX), to access content that originates in an edX
course. However, the first time a learner views edX course content in the
external LMS, she might have to re-enter her credentials for the external LMS,
even though she is already signed in to the external LMS.

Internally, the edX instance associates a unique internal identifier to each
learner's credentials to allow for a streamlined, single sign in experience in
the future. However, this separate edX identifier can make some edX content
confusing for learners when viewed in the context of an external LMS. For
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.
other system (including your Open edX instance), to access content that
originates in an course in your instance. However, the first time a learner
views Open edX course content in the external LMS, she might have to re-enter
her credentials for the external LMS, even though she is already signed in to
the external LMS.

Internally, the Open edX instance associates a unique internal identifier to
each learner's credentials to allow for a streamlined, single sign in
experience in the future. However, this separate identifier can make
some content confusing for learners when viewed in the context of an
external LMS. For example, Open edX course discussions can identify
participants by these unique IDs instead of the usernames they would normally
see in the external LMS. As a result, some Open edX content is not currently
suitable for use in an external LMS.

For more information, see :ref:`Preparing Content`.

******************************
Learner Progress and Grades
******************************
***************************

Each learner's progress through the edX content is saved. Learners start, stop,
and resume work in the external LMS in the same way that they would in the edX
LMS.
Each learner's progress through the Open edX content is saved. Learners start,
stop, and resume work in the external LMS in the same way that they would in
the Open edX LMS.

Learner responses to edX problem components are graded by the edX system, and
then transferred automatically to the grade book in the external LMS. For more
information, see :ref:`Grading Remote Content`.
Learner responses to Open edX problem components are graded by the Open edX
system, and then transferred automatically to the grade book in the external
LMS. For more information, see :ref:`Grading Remote Content`.

To obtain learner engagement and performance data, you use the features
available in the external LMS.
available in the external LMS.

.. seealso::
:class: dropdown

:doc: `using_openedx_as_LTI_provider` (concept)

:doc: `/how-tos/advanced_features/lti_prepare_content` (how-to)

:doc: `/how-tos/advanced_features/lti_determine_content_address` (how-to)

:doc: `/references/advanced_features/planning_content_reuse` (reference)

:doc: `/references/advanced_features/lti_canvas_example` (reference)

:doc: `/references/advanced_features/lti_blackboard_example` (reference)
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
.. _Teams Discussions:


#########################
Managing Team Discussions
#########################
Managing Teams Discussions
##########################

.. tags:: educator, concept

EdX recommends that you designate course staff and optionally student teaching
assistants (TAs) to moderate team discussions. The same discussion
administration roles for managing course discussions on the **Discussions** page
apply to discussion administration for team discussions. Course team members and
student TAs who already have discussion moderation roles for course discussions
on the **Discussions** page can perform the same roles for discussions in teams.
The Open EdX community recommends that you designate course staff and
optionally student teaching assistants (TAs) to moderate team discussions. The
same discussion administration roles for managing course discussions on the
**Discussions** page apply to discussion administration for team discussions.
Course team members and student TAs who already have discussion moderation
roles for course discussions on the **Discussions** page can perform the same
roles for discussions in teams.

For information about discussion administration roles, see
:ref:`Assigning_discussion_roles`. For information about managing discussions,
Expand All @@ -22,7 +21,6 @@ see :ref:`Running_discussions`.
:local:
:depth: 1

***********************************
Ability to Post in Team Discussions
***********************************

Expand All @@ -35,9 +33,8 @@ Posts made by discussion community TAs are marked with a **Community TA** label
in the discussion navigation pane, and those made by discussion moderators or
discussion admins are marked with a **Staff** label.

***********************************
Ability to Edit or Delete Posts
***********************************
*******************************

Discussion moderators, discussion admins, and community TAs can perform the
following actions in team discussions, without being a member of the team.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
.. _CA Learner Experience of Teams:


##########################################
The Learner's Experience of Teams
##########################################
#################################

.. tags:: educator, concept

Expand All @@ -15,15 +13,13 @@ within topics. Each learner can belong to only one team.
:local:
:depth: 1

***********************************
Browsing Teams by Topic
***********************************
***********************

On the **Teams** page in the LMS, learners in your course can browse topics to
find a subject that they are interested in collaborating on. Learners can sort
topics alphabetically by name, or by the number of teams in a topic.


.. image:: /_images/educator_concepts/Teams_TopicArrowButton.png
:width: 500
:alt: On the page showing available topics, one topic has the arrow button
Expand Down Expand Up @@ -51,10 +47,8 @@ identify with. While they are browsing teams, learners can read any team's
discussion posts, but they cannot add posts to a team's discussion forum
unless they join that team.


*************************************
Joining, Creating, or Leaving a Team
*************************************
************************************

When learners find a team that they want to join, they select **Join Team**
and are immediately added to the team membership.
Expand All @@ -76,7 +70,7 @@ Learners specify a name and description for their team, and optionally specify
a country and language that team members identify with. A learner who creates
a team automatically becomes a member of the new team.

.. note:: EdX recommends that you encourage learners to join existing teams
.. note:: The recommendation is to encourage learners to join existing teams
before they create new teams.

.. note:: Because course staff who have the role of Admin, Discussion Moderator,
Expand All @@ -92,10 +86,8 @@ they have left.

.. Add back Invite Others when available


*************************************
Participating in Team Discussions
*************************************
*********************************

Only members of a team (or anyone with a discussion administrator, discussion
moderator, or community TA role) can post to a team's discussion forum. Any
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _CA_Teams_Overview:

***************
Teams Overview
***************
##############

.. tags:: educator, concept

Expand Down
Original file line number Diff line number Diff line change
@@ -1,47 +1,34 @@
.. _Using Open edX as an LTI Tool Provider:

#######################################
Using Open edX as an LTI Tool Provider
#######################################
######################################

.. tags:: educator, concept

.. note:: This feature was a closed pilot experiment. This feature is not
supported for new users.

An experimental feature enabled the edX Edge site to be configured to be a
learning tool interoperability (LTI) provider to other systems and applications
that partner institutions use. After initial configuration and testing between
Edge and your system or application is complete, course teams could use this
feature to reuse Edge course content, including advanced problem types and
videos, in an on campus or in house learning management system. Examples
currently include courses running on Canvas and Blackboard.

You can also include content from an LTI provider in your edX courses. For
more information, see :ref:`LTI Component`.
You can also include content from an LTI provider in your courses. For more
information, see :ref:`LTI Component`.

.. _Grading Remote Content:

******************************
Grading Remote Content
******************************
**********************

.. note:: This feature was a closed pilot experiment. This feature is not
supported for new users.
.. warning:: This feature was a closed pilot experiment. This feature is poorly
documented and may not work properly.

When you include the problem components in a graded edX subsection in an
external LMS, the edX system grades the learner responses to those problems.
The edX system then transfers the learner scores back to the external LMS. This
exchange between an external LMS, the edX system, and the external LMS again is
near real time. It can take a few moments to complete this exchange for a
single problem component, and up to several minutes to return aggregated scores
of all of the problems in a unit or subsection.
When you include the problem components in a graded Open edX subsection in an
Copy link
Contributor

Choose a reason for hiding this comment

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

I would rewrite this paragraph because it is confusing, it talks about "Open edX" as a thing when really it needs to be discussing your specific Open edX instance.

When you include problem components from a graded subsection in your Open edX instance in an external LMS, your Open edX instance will grade the learner responses to those problems. Your instance then transfers the learner scores back to the external LMS. This exchange between an external LMS, your Open edX instance, and the external LMS again is near real time. It can take a few moments to complete this exchange for a single problem component, and up to several minutes to return aggregated scores of all the problems in a unit or subsection.

Copy link
Contributor Author

@BryanttV BryanttV Jan 9, 2025

Choose a reason for hiding this comment

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

Thanks!, I applied your suggestion: 1d2621d

external LMS, the Open edX system grades the learner responses to those
problems. The Open edX system then transfers the learner scores back to the
external LMS. This exchange between an external LMS, the Open edX system, and
the external LMS again is near real time. It can take a few moments to complete
this exchange for a single problem component, and up to several minutes to
return aggregated scores of all of the problems in a unit or subsection.

When you include edX problem components in an external LMS, note the following
requirements.
When you include Open edX problem components in an external LMS, note the
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When you include Open edX problem components in an external LMS, note the
When you include problem components from your Open edX instance in an external LMS, note the

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated: 1d2621d

following requirements.

* The edX problem component must be in one of the graded subsections in your
course.
* The Open edX problem component must be in one of the graded subsections in
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* The Open edX problem component must be in one of the graded subsections in
* The problem component must be in one of the graded subsections in

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated: 1d2621d

your course.

* Your external LMS might also require that you use a specific part of the
course for graded content. For example, in Canvas, you must add the LTI URL
Expand All @@ -64,4 +51,8 @@ For more information about constructing an LTI URL for a course component, see

:ref:`Example: edX as an LTI Provider to Canvas<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<edX as an LTI Provider to Blackboard>` (reference)

:ref: `edX as an LTI Provider to Canvas` (reference)
Copy link
Contributor

Choose a reason for hiding this comment

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

Where is this reference and why is it not Open edX?

Copy link
Contributor

Choose a reason for hiding this comment

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

This reference is the Open edX repository, but the tag name of that file wasn't modified to prevent the broken links.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated the references to use the correct tags: 4daafbe. Thanks!


:ref: `edX as an LTI Provider to Blackboard` (reference)
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here

Copy link
Contributor Author

@BryanttV BryanttV Jan 9, 2025

Choose a reason for hiding this comment

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

I updated the references to use the correct tags: 4daafbe. Thanks!

Loading