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: reference and how-tos reviewed by edunext 20 #771

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 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
13 changes: 10 additions & 3 deletions source/educators/how-tos/add_course_updates.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
Add Course Updates and Hand-outs
Add Course Updates and Handouts
################################

.. tags:: educator, how-to

Watch this video to understand how to add course updates and hand-outs:
Watch this video to understand how to add course updates and handouts:

.. youtube:: 3rPeuFR6UDI
.. youtube:: 3rPeuFR6UDI

.. seealso::
:class:dropdown

:ref:`Adding Course Updates and Handouts` (reference)

:ref:`Add a Course Update` (how-to)
4 changes: 2 additions & 2 deletions source/educators/how-tos/add_units.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _Add Units to the Outline:

########################
Add Units to the Outline
########################

.. tags:: educator, how-to

.. include:: ../how-tos/reusable_content/create_unit.txt
.. include:: ../how-tos/reusable_content/create_unit.txt

Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
.. _Email Task History Report:

Email Task History Report
Apgomeznext marked this conversation as resolved.
Show resolved Hide resolved
###########################

.. tags:: educator, how-to

The Email Task History report can help you keep track of who sent messages,
when, to which groups, and how many messages were successfully sent. For each
message sent, the report includes the username of the requester, the date and
time it was submitted, the duration and state of the entire task, the task
status, and the task progress.

You can use this history to investigate questions relating to bulk email
messages that have been sent, such as these examples.

* How frequently learners are sent course-related email messages.
* Whether a message was sent successfully.
* The change in the number of people who were sent course-related messages over
time.

To produce the Email Task History report, follow these steps.

#. View the live version of your course.

#. Select **Instructor**, and then select **Email**.

#. In the **Email Task History** section of the page, select **Show Email Task
History**. A report like the following example displays on the instructor
dashboard.

.. image:: /_images/educator_how_tos/Bulk_email_history.png
:alt: A tabular report with a row for each message sent and columns for
requester, date and time submitted, duration, state, task status,
and task progress.


Review Email Task History
***************************

For tasks with a **State** of Success, the **Task Progress** column shows an
informational message. These messages can have a format such as "Message
successfully emailed for 13457 recipients (skipping 29) (out of 13486)". To
interpret this message, note that:

* The first number ("recipients") indicates the number of messages sent to the
selected recipients.

* The second number ("skipping") indicates the number of enrolled and activated
users who were not sent the message. This count is of learners who have opted
not to receive course email messages.

* The final number ("out of") indicates the number of users in the set of
recipients you selected who were enrolled in the course (and had activated
their user accounts) when you sent the email message.

If the "recipients" and "out of" numbers are the same, the message reads
"Message successfully emailed for 13457 recipients" instead.

Other **Task Progress** messages for tasks with a **State** of Success indicate
that some or all of the emailing subtasks did not successfully send email:

* "Message emailed for {number succeeded} of {number attempted} recipients"
* "Message failed to be emailed for any of {number attempted} recipients"
* "Unable to find any recipients to be emailed"

No **Task Progress** messages display for tasks that have a **State** of
Failure.

.. seealso::
:class: dropdown

:ref:`Bulk Email` (reference)

:ref:`Send_Bulk_Email` (how-to)

:ref:`Review Sent Messages` (how-to)

:ref:`Example Messages to Students` (reference)

:ref:`Options for Email Message Text` (reference)


Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _Additional Video Options:

###################################
Specifying Additional Video Options
Apgomeznext marked this conversation as resolved.
Show resolved Hide resolved
###################################

Expand All @@ -16,11 +15,10 @@ and a start and stop time for the video.

.. _Enable Video and Transcript Downloads:

********************************************
Enable Video and Transcript Downloads
********************************************

You can allow learners to download videos and transcript files that you have
You can allow learners to download videos and transcript files you have
provided so that they can view them offline.

To enable video and transcript downloads, follow these steps.
Expand All @@ -37,7 +35,6 @@ format or text (.txt) format.

.. _Video Settings:

**************************
Set Video Settings
**************************

Expand All @@ -51,12 +48,12 @@ The following options appear on the **Edit** page of the video component.
:widths: 30 70

* - **Component Display Name**
- The name that you want your learners to see. To edit the display name,
- The name you want your learners to see. To edit the display name,
select the pencil icon inthe top left hand corner.

.. _Video Source:

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

Video Source
===============

Expand All @@ -65,8 +62,7 @@ Video Source

* - **Video ID**
- The Video IDis the source for your video. Video IDs are the
identifiers that the video process assigns to the video. Only courses on
edx.org use Video IDs.
identifiers that the video process assigns to the video.

* - **Video URL**
- The Video URL is the source for your video. Video URLS are for externally
Expand All @@ -90,11 +86,10 @@ Video Source
the 360p version of the video is the first URL in the list.

To help make sure all standard browsers can play your video, we
**strongly** recommend that you use the .mp4 format.
**strongly** recommend you use the .mp4 format.

.. _Thumbnail:

===============
Thumbnail
===============

Expand All @@ -117,7 +112,6 @@ steps above for adding a thumbnail

.. _Transcript:

============
Transcript
============

Expand All @@ -141,7 +135,7 @@ Transcript
downloads**, a link to download the file appears below the video.

If you want to provide a downloadable transcript in a different format
as well, such as .pdf, edX recommends that you upload a handout for learners by
as well, such as .pdf, the recommendation is to upload a handout for learners by
using the **Upload Handout** field. For more information, see
:ref:`Additional Transcripts`.

Expand All @@ -152,7 +146,6 @@ Transcript

.. _Duration:

===============
Duration
===============

Expand Down Expand Up @@ -185,7 +178,6 @@ Duration

.. _Handout:

==============
Handout
==============

Expand All @@ -204,7 +196,6 @@ Handout

.. _License:

===============
License
===============

Expand All @@ -219,14 +210,14 @@ License
release the video with a license different from the overall course
license.

* Select **All Rights Reserved** to indicate to learners that you own
* Select **All Rights Reserved** to indicate to learners you own
the copyright for the video.

* Select **Creative Commons** to grant others the right to share and
use the video. You must then select the Creative Commons license
options that you want.
options you want.

The license options that you select control the copyright notice that
The license options you select control the copyright notice that
learners see for the video. For more information, see :ref:`Licensing
a Course`.

Expand Down
18 changes: 13 additions & 5 deletions source/educators/how-tos/course_development/create_discussion.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _Working with Discussion Components:

###################################
Working with Discussion Components
###################################

Expand All @@ -11,7 +10,7 @@ components, such as videos or text, in the unit. A discussion component gives
learners a chance to respond to and interact with each other about a specific
subject.

Discussion topics that you create by adding discussion components in your
Discussion topics you create by adding discussion components in your
Apgomeznext marked this conversation as resolved.
Show resolved Hide resolved
course are known as content-specific discussion topics.

For more information about discussions, see these topics.
Expand All @@ -26,8 +25,8 @@ For more information about discussions, see these topics.
Create a Discussion Component
*****************************

.. note:: EdX recommends that you add a Text component before each discussion
component to introduce the topic that you want learners to discuss. The
.. note:: The recommendation is to add a Text component before each discussion
component to introduce the topic you want learners to discuss. The
discussion component itself does not contain any text and can be easy for
learners to overlook.

Expand Down Expand Up @@ -66,6 +65,15 @@ Create a Discussion Component
#. Select **Save**.

.. note:: On the **Discussion** page, you cannot see category and subcategory
names of discussion components that you created until after the course has
names of discussion components you created until after the course has
started and the unit is released. For more details about when discussion
topics are visible, see :ref:`Visibility of Discussion Topics`.

.. seealso::
:class:dropdown

:ref:`Discussions` (concept)

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

:ref:`Set up Discussions in Cohorted Courses` (how-to)
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
.. _Add a Google Drive File to Your Course:

========================================
Add a Google Drive File to Your Course
========================================
##########################################

.. tags:: educator, how-to

To add a Google Drive file in the course body, you create an advanced
component in Studio or create a Google Document XBlock in OLX.

.. _Add a Google Drive File Component in edX Studio:
.. _Add a Google Drive File Component in Open edX Studio:

Add a Google Drive File Component in edX Studio
Add a Google Drive File Component in Open edX Studio
******************************************************

Ensure you :ref:`enable Google Drive files<Enable the Google Drive Files Tool>`
Expand All @@ -32,7 +31,7 @@ To add a Google Drive file component, follow these steps.

#. In the **Display Name** field, enter the name for the component.

#. In the **Embed Code** field, paste the embed code that you copied in the
#. In the **Embed Code** field, paste the embed code you copied in the
:ref:`Obtain the Google Drive File Embed Code` task.

#. Select **Save**.
Expand All @@ -48,12 +47,9 @@ Add a Google Drive File XBlock in OLX
To add a Google Drive file XBlock in OLX, you create the
``google-document`` element. You can embed the ``google-document``
element in the ``vertical`` element, or you can create the
``google-document`` element as a stand-alone file that you reference
``google-document`` element as a stand-alone file you reference
in the vertical.

For more information, see `OLX Course Building Blocks`_ in the
*EdX Open Learning XML Guide*.

For example:

.. code-block:: xml
Expand All @@ -68,7 +64,7 @@ The value of the ``embed_code`` attribute is the embed code you copied in the
:ref:`Obtain the Google Drive File Embed Code` task.

.. note::
The edX Learning Management System sets the height and width values for
The Open edX LMS sets the height and width values for
Google Drive files. If you add these attributes, the LMS overrides your
changes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ Bulk Emails
../references/communication/bulk_email.rst
../how-tos/communication/send_bulk_email.rst
../how-tos/communication/review_sent_messages.rst
../references/communication/example_bulk_emails.rst
../references/communication/example_bulk_emails.rst
../references/communication/compose_email_message.rst
../how-tos/communication/email_task_history_report.rst

Automatic Emails
*******************************************************
Expand Down
Loading