From 1fa104cbb434be9b7edd448e225bca71560f4587 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Mon, 13 Jan 2025 16:53:09 -0500 Subject: [PATCH 01/12] FC-0068 docs: reference and how-tos reviewed by edunext 20 This PR modifies how-to and reference4 documents migrated from the legacy repositories to the educators' documentation. --- .../educators/how-tos/add_course_updates.rst | 13 +- source/educators/how-tos/add_units.rst | 4 +- .../email_task_history_report.rst | 83 +++++++ .../additional_video_options.rst | 27 +-- .../course_development/create_discussion.rst | 18 +- .../exercise_tools/add_google_drive.rst | 16 +- .../learner_engagement_communication.rst | 4 +- .../communication/automatic_email.rst | 76 +++---- .../references/communication/bulk_email.rst | 203 +----------------- .../communication/compose_email_message.rst | 127 +++++++++++ .../communication/course_updates_handouts.rst | 1 - .../communication/example_bulk_emails.rst | 84 ++++---- .../communication/learner_view_discussion.rst | 38 +++- .../course_development/about_course_wiki.rst | 7 +- 14 files changed, 372 insertions(+), 329 deletions(-) create mode 100644 source/educators/how-tos/communication/email_task_history_report.rst create mode 100644 source/educators/references/communication/compose_email_message.rst diff --git a/source/educators/how-tos/add_course_updates.rst b/source/educators/how-tos/add_course_updates.rst index 3997197e7..b22ee696e 100644 --- a/source/educators/how-tos/add_course_updates.rst +++ b/source/educators/how-tos/add_course_updates.rst @@ -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 \ No newline at end of file +.. youtube:: 3rPeuFR6UDI + +.. seealso:: + :class:dropdown + + :ref:`Adding Course Updates and Handouts` (reference) + + :ref:`Add a Course Update` (how-to) diff --git a/source/educators/how-tos/add_units.rst b/source/educators/how-tos/add_units.rst index 49401cb89..5a1deeb5a 100644 --- a/source/educators/how-tos/add_units.rst +++ b/source/educators/how-tos/add_units.rst @@ -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 \ No newline at end of file +.. include:: ../how-tos/reusable_content/create_unit.txt + diff --git a/source/educators/how-tos/communication/email_task_history_report.rst b/source/educators/how-tos/communication/email_task_history_report.rst new file mode 100644 index 000000000..868e90ce3 --- /dev/null +++ b/source/educators/how-tos/communication/email_task_history_report.rst @@ -0,0 +1,83 @@ +.. _Email Task History Report: + +Email Task History Report +########################### + +.. 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) + + \ No newline at end of file diff --git a/source/educators/how-tos/course_development/additional_video_options.rst b/source/educators/how-tos/course_development/additional_video_options.rst index 0a9f8d032..4687b6e6b 100644 --- a/source/educators/how-tos/course_development/additional_video_options.rst +++ b/source/educators/how-tos/course_development/additional_video_options.rst @@ -1,6 +1,5 @@ .. _Additional Video Options: -################################### Specifying Additional Video Options ################################### @@ -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. @@ -37,7 +35,6 @@ format or text (.txt) format. .. _Video Settings: -************************** Set Video Settings ************************** @@ -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 =============== @@ -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 @@ -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 =============== @@ -117,7 +112,6 @@ steps above for adding a thumbnail .. _Transcript: -============ Transcript ============ @@ -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`. @@ -152,7 +146,6 @@ Transcript .. _Duration: -=============== Duration =============== @@ -185,7 +178,6 @@ Duration .. _Handout: -============== Handout ============== @@ -204,7 +196,6 @@ Handout .. _License: -=============== License =============== @@ -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`. diff --git a/source/educators/how-tos/course_development/create_discussion.rst b/source/educators/how-tos/course_development/create_discussion.rst index 1b989f465..a0f386e09 100644 --- a/source/educators/how-tos/course_development/create_discussion.rst +++ b/source/educators/how-tos/course_development/create_discussion.rst @@ -1,6 +1,5 @@ .. _Working with Discussion Components: -################################### Working with Discussion Components ################################### @@ -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 course are known as content-specific discussion topics. For more information about discussions, see these topics. @@ -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. @@ -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) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_google_drive.rst b/source/educators/how-tos/course_development/exercise_tools/add_google_drive.rst index a7dc25c78..870bbc78c 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_google_drive.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_google_drive.rst @@ -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` @@ -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**. @@ -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 @@ -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. diff --git a/source/educators/navigation/learner_engagement_communication.rst b/source/educators/navigation/learner_engagement_communication.rst index 443644b6e..18bcdd364 100644 --- a/source/educators/navigation/learner_engagement_communication.rst +++ b/source/educators/navigation/learner_engagement_communication.rst @@ -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 ******************************************************* diff --git a/source/educators/references/communication/automatic_email.rst b/source/educators/references/communication/automatic_email.rst index cb554d125..d413d96bd 100644 --- a/source/educators/references/communication/automatic_email.rst +++ b/source/educators/references/communication/automatic_email.rst @@ -1,8 +1,7 @@ .. _Automatic Email: -################################# -Automatic Email Messages from edX -################################# +Automatic Email Messages from Open edX Instance +############################################### .. tags:: educator, reference @@ -10,7 +9,7 @@ Automatic Email Messages from edX .. be made to the manage_live_course/automatic_email.rst file in the Open edX .. course authors guide. -To help learners become and remain engaged in a course, edX sends several types +To help learners become and remain engaged in a course, the Open edX instance sends several types of automatic email messages. .. list-table:: @@ -50,11 +49,10 @@ of automatic email messages. Course Highlight Messages`. -***************************** Automatic Email Message Text ***************************** -The following example messages show the text of the email messages that edX +The following example messages show the text of the email messages that an Open edX intance might sends to learners automatically. .. contents:: @@ -63,32 +61,29 @@ sends to learners automatically. .. _Day 3 Nudge Message: -=================== Day 3 Nudge Message =================== -EdX sends the following message three days after a learner enrolls in a course. +An Open edX intance might sends the following message three days after a learner enrolls in a course. :: - Subject: Keep learning in Creating a Course with edX Studio! + Subject: Keep learning in Creating a Course! - Remember when you enrolled in Creating a Course with edX Studio on edX.org? + Remember when you enrolled in Creating a Course? We do, and we’re glad to have you! Come see what everyone is learning. -EdX sends the following message three days after a learner enrolls in more than -one course. +This another example. :: - Subject: Keep learning on edX! + Subject: Keep learning with us! - Remember when you enrolled in Creating a Course with edX Studio and other - courses on edX.org? We do, and we’re glad to have you! Come see what everyone + Remember when you enrolled in Creating a Course and other + courses with us? We do, and we’re glad to have you! Come see what everyone is learning. .. _Day 10 Nudge Message: -==================== Day 10 Nudge Message ==================== @@ -96,24 +91,23 @@ Day 10 Nudge Message If learners receive a :ref:`course highlight message ` on day 7, they do not receive this day 10 nudge message. -EdX sends the following message 10 days after a learner enrolls in a course. +An Open edX intance might sends the following message 10 days after a learner enrolls in a course. :: Subject: Keep up the momentum! - Many edX learners in Creating a Course with edX Studio are completing more + Many learners in Creating a Course are completing more problems every week, and participating in the discussion forums. What do you want to do to keep learning? -EdX sends the following message 10 days after a learner enrolls in more than -one course. +Here is another example: :: Subject: Keep up the momentum! - Many edX learners are completing more problems every week, and participating + Many learners are completing more problems every week, and participating in the discussion forums. What do you want to do to keep learning? .. _Day 19 Upgrade Reminder: @@ -126,30 +120,26 @@ Day 19 Upgrade Reminder If learners receive :ref:`course highlight messages `, they do not receive this upgrade reminder. -EdX sends the following message 19 days after a learner enrolls in a course or +An Open edX intance might sends the following message 19 days after a learner enrolls in a course or two days before the upgrade deadline for the course. :: - Subject: Upgrade to earn a verified certificate in Creating a Course with edX - Studio + Subject: Upgrade to earn a verified certificate in Creating a Course - We hope you’re enjoying learning with us so far in Creating a Course with edX - Studio! A verified certificate will allow to you highlight your new knowledge - and skills. An edX certificate is official and easily shareable. + We hope you’re enjoying learning with us so far in Creating a Course with us! A verified certificate will allow to you highlight your new knowledge + and skills. A certificate is official and easily shareable. Upgrade by November 25, 2017. -EdX sends the following message 19 days after a learner enrolls in more than -one course or two days before the upgrade deadline for one of the learner's -courses. +Another email example may be: :: - Subject: Upgrade to earn a verified certificate on edX + Subject: Upgrade to earn a verified certificate! - We hope you’re enjoying learning with us so far on edX! A verified - certificate allows to you highlight your new knowledge and skills. An edX + We hope you’re enjoying learning with us so far! A verified + certificate allows to you highlight your new knowledge and skills. A certificate is official and easily shareable. Upgrade by November 25, 2017. @@ -160,7 +150,7 @@ courses. Course Highlight Email ================================ -EdX sends Course Highlight messages for both Instructor-paced and Self-paced +An Open edX intance might sends Course Highlight messages for both Instructor-paced and Self-paced courses. The logic for when the message is sent depends on the Course pacing. * Instructor-paced: @@ -178,21 +168,31 @@ Messages`. .. include:: ../reusable_references/course_highlight_message_text.rst - .. _Discussion Notification: ======================= Discussion Notification ======================= -After a learner or course team member creates a post in the course discussions, edX sends the following email message the first time a learner or course team member replies to the original post. +After a learner or course team member creates a post in the course discussions, the Open edX intance might sends the following email message the first time a learner or course team member replies to the original post. :: Subject: Response to - <edX username> replied to <title of post>: + <username> replied to <title of post>: <text of comment> -The message also contains a View discussion option that takes the learner to the discussion post. EdX does not send individual messages for any additional replies on the post. \ No newline at end of file +The message also contains a View discussion option that takes the learner to the discussion post. An Open edX intance does not send individual messages for any additional replies on the post. + +.. seealso:: + :class:dropdown + + :ref:`Bulk Email` (reference) + + :ref:`Send_Bulk_Email` (how-to) + + :ref:`Example Messages to Students` (reference) + + :ref:`Review Sent Messages` (how-to) diff --git a/source/educators/references/communication/bulk_email.rst b/source/educators/references/communication/bulk_email.rst index ec32e40da..4a70a4e4e 100644 --- a/source/educators/references/communication/bulk_email.rst +++ b/source/educators/references/communication/bulk_email.rst @@ -1,12 +1,11 @@ .. _Bulk Email: -######################################## Bulk Email Messages from the Course Team ######################################## .. tags:: educator, reference -For courses on edx.org, you can send bulk email messages to course participants +For courses on an Open edX instance, you can send bulk email messages to course participants directly from the instructor dashboard: in the LMS, select **Instructor**, and then select **Email**. @@ -21,7 +20,7 @@ one email message per week to course participants, unless there is good reason to do so. .. note:: Some courses use third party services such as MailChimp to send bulk - email. Do not use both a third party service and the edX bulk email + email. Do not use both a third party service and the Open edX bulk email service. If you use more than one service to send email message, your messages are more likely to be marked as spam, and learners might not read them. @@ -34,7 +33,6 @@ This section contains the following topics. .. _bulk_email_message_addressing: -************************* Message Addressing ************************* @@ -75,7 +73,6 @@ separate recipient group. For more information, see :ref:`Bulk Email Cohorts`. .. _Bulk Email Who Is Included or Excluded: -========================================= Who Is Included in Each Recipient Group? ========================================= @@ -84,10 +81,10 @@ should be aware of who is included in each group. .. note:: It is considered good practice to only send messages to active and engaged learners. For this reason, regardless of the recipient groups - selected, edX will only send email messages to learners in a course run who + selected, the Open edX platform will only send email messages to learners in a course run who have logged in within the last 18 months. This helps reduce the risk of messages being marked as spam (or bouncing) and helps ensure the continued - delivery of bulk course email messages through edX's email providers. + delivery of bulk course email messages through Open edX's email providers. .. list-table:: :widths: 30 40 40 @@ -112,7 +109,7 @@ should be aware of who is included in each group. - * All currently enrolled learners in your course, including those who have enrolled but have not yet accessed the course. - * Learners who have not replied to the account activation email message - that they received when they registered on edx.org. + that they received when they registered on your Open edX instance. * Learners who have opted out of receiving email messages through the **Email Settings** link for the course on the learner's dashboard. * Course team members, regardless of whether they are enrolled in the @@ -164,81 +161,8 @@ Default Group** is also available. cohort. You can manually reassign learners from the default cohort to another cohort. For more information, see :ref:`Default Cohort Group`. - -.. _Options for Email Message Text: - -******************************* -Composing Email Messages -******************************* - -When you compose an email message, you can use the following options. - -.. contents:: - :local: - :depth: 2 - -======= -Styling -======= - -Messages can include HTML styling, including text formatting and links. - -For more information, see :ref:`Working with Text Components<working with text components>`. - ------------------------ -Restricted HTML Content ------------------------ - -The Bulk Course Email tool restricts use of specific HTML elements from being -used in messages. The following HTML elements may not be used in messages -authored with this tool: - -* iframe -* svg -* form -* script - -.. note: If a message contains restricted HTML content it will **not** be - stripped from the message. The HTML code will be converted to plain text. You - should send a test message to yourself first before sending to larger groups - to ensure message content is displayed as desired. - -====== -Images -====== - -Messages can include images. To include an image, you must first add the file -to your course on the **Files & Uploads** page. For an email message, you copy -the **Web** URL that the system assigns to the image. Then, in the email -message editor, you select the **Insert/edit image** icon to add the web URL. - -.. note:: Scalable Vector Graphic (SVG) images are restricted from use in - messages authored with the Bulk Course Email tool. Please see the above note - in the *Restricted HTML Content* section. - -To ensure that your course assets are transmitted securely, add the -``https://`` preface to the web URL. An example follows. - -:: - - https://courses.edx.org/asset-v1:{course}.x+{run}+type@asset+block@{image}.jpg - -For more information, see :ref:`Add Files to a Course`. - -========= -Keywords -========= - -Messages can include variables that represent values that are specific to each -message recipient, such as learner name or user ID. The LMS substitutes these -variables, called keywords, with actual values when it sends a message. - -For more information, see :ref:`Use Keywords in Messages`. - - -===================================== Managing Scheduled Email Messages -===================================== +********************************** Once a message has been scheduled it will appear in the **Scheduled emails** table. Each entry will describe *when* the message will be sent (in local time), @@ -260,51 +184,8 @@ Each scheduled email entry in this table will support the following actions: time the message should be sent. -.. _Use Keywords in Messages: - -**************************** -Use Keywords in Messages -**************************** - -You can include keywords in your messages. A keyword is a variable: when you -send the message, a value that is specific to the each recipient is substituted -for the keyword. For example, when you use the ``%%USER_FULLNAME%%`` keyword, -each message contains the name of the recipient. - -.. note:: - Do not use keywords in the Subject line of a message. The keyword in the - subject will not be assigned a value, and the recipient will see the keyword - text. - -=================== -Supported Keywords -=================== - -You can use the following keywords in your messages. - -* ``%%USER_ID%%`` - the anonymous user ID of the message recipient -* ``%%USER_FULLNAME%%`` - the full name of the message recipient -* ``%%COURSE_DISPLAY_NAME%%`` - the display name of the course -* ``%%COURSE_END_DATE%%`` - the end date of the course - -=================== -Keyword Formatting -=================== - -You format keywords as: ``%%Keyword%%``. You can include keywords in any HTML -tags in an email message. An example follows. - -:: - - <h2>%%COURSE_DISPLAY_NAME%% Updates</h2> - - <p>Dear %%USER_FULLNAME%%, this is a reminder that the last day of the course - is <b>%%COURSE_END_DATE%%</b></p> - . . . - .. _Email_queuing: -**************************** Message Workflow States **************************** @@ -345,74 +226,6 @@ When the bulk email task is complete, you can find its final state by checking the Email Task History report. For more information, see :ref:`Email Task History Report`. -.. _Email Task History Report: - -******************************** -Email Task History Report -******************************** - -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 @@ -420,7 +233,11 @@ Failure. :ref:`Review Sent Messages` (how-to) + :ref:`Email Task History Report` (how-to) + :ref:`Example Messages to Students` (reference) + :ref:`Options for Email Message Text` (reference) + \ No newline at end of file diff --git a/source/educators/references/communication/compose_email_message.rst b/source/educators/references/communication/compose_email_message.rst new file mode 100644 index 000000000..0d4c4bfc3 --- /dev/null +++ b/source/educators/references/communication/compose_email_message.rst @@ -0,0 +1,127 @@ +.. _Options for Email Message Text: + +Composing Email Messages +########################## + +.. tags:: educator, reference + +When you compose an email message, you can use the following options. + +.. contents:: + :local: + :depth: 2 + + +Styling +********* + +Messages can include HTML styling, including text formatting and links. + +For more information, see :ref:`Working with Text Components<working with text components>`. + +Restricted HTML Content +======================== + +The Bulk Course Email tool restricts use of specific HTML elements from being +used in messages. The following HTML elements may not be used in messages +authored with this tool: + +* iframe +* svg +* form +* script + +.. note:: If a message contains restricted HTML content it will **not** be + stripped from the message. The HTML code will be converted to plain text. You + should send a test message to yourself first before sending to larger groups + to ensure message content is displayed as desired. + + +Images +******** + +Messages can include images. To include an image, you must first add the file +to your course on the **Files & Uploads** page. For an email message, you copy +the **Web** URL that the system assigns to the image. Then, in the email +message editor, you select the **Insert/edit image** icon to add the web URL. + +.. note:: Scalable Vector Graphic (SVG) images are restricted from use in + messages authored with the Bulk Course Email tool. Please see the above note + in the *Restricted HTML Content* section. + +To ensure your course assets are transmitted securely, add the +``https://`` preface to the web URL. An example follows. + +:: + + https://courses.openedx.org/asset-v1:{course}.x+{run}+type@asset+block@{image}.jpg + +For more information, see :ref:`Add Files to a Course`. + + +Keywords +********* + +Messages can include variables that represent values that are specific to each +message recipient, such as learner name or user ID. The LMS substitutes these +variables, called keywords, with actual values when it sends a message. + +For more information, see :ref:`Use Keywords in Messages`. + + +.. _Use Keywords in Messages: + +**************************** +Use Keywords in Messages +**************************** + +You can include keywords in your messages. A keyword is a variable: when you +send the message, a value that is specific to the each recipient is substituted +for the keyword. For example, when you use the ``%%USER_FULLNAME%%`` keyword, +each message contains the name of the recipient. + +.. note:: + Do not use keywords in the Subject line of a message. The keyword in the + subject will not be assigned a value, and the recipient will see the keyword + text. + +=================== +Supported Keywords +=================== + +You can use the following keywords in your messages. + +* ``%%USER_ID%%`` - the anonymous user ID of the message recipient +* ``%%USER_FULLNAME%%`` - the full name of the message recipient +* ``%%COURSE_DISPLAY_NAME%%`` - the display name of the course +* ``%%COURSE_END_DATE%%`` - the end date of the course + +=================== +Keyword Formatting +=================== + +You format keywords as: ``%%Keyword%%``. You can include keywords in any HTML +tags in an email message. An example follows. + +:: + + <h2>%%COURSE_DISPLAY_NAME%% Updates</h2> + + <p>Dear %%USER_FULLNAME%%, this is a reminder that the last day of the course + is <b>%%COURSE_END_DATE%%</b></p> + . . . + + +.. seealso:: + :class: dropdown + + :ref:`Bulk Email` (reference) + + :ref:`Send_Bulk_Email` (how-to) + + :ref:`Review Sent Messages` (how-to) + + :ref:`Email Task History Report` (how-to) + + :ref:`Example Messages to Students` (reference) + \ No newline at end of file diff --git a/source/educators/references/communication/course_updates_handouts.rst b/source/educators/references/communication/course_updates_handouts.rst index 3c18f612b..002d2c706 100644 --- a/source/educators/references/communication/course_updates_handouts.rst +++ b/source/educators/references/communication/course_updates_handouts.rst @@ -1,6 +1,5 @@ .. _Adding Course Updates and Handouts: -################################## Adding Course Updates and Handouts ################################## diff --git a/source/educators/references/communication/example_bulk_emails.rst b/source/educators/references/communication/example_bulk_emails.rst index 75f0472e4..644d21af3 100644 --- a/source/educators/references/communication/example_bulk_emails.rst +++ b/source/educators/references/communication/example_bulk_emails.rst @@ -1,8 +1,7 @@ .. _Example Messages to Students: -********************************* Example Messages to Learners -********************************* +############################# .. tags:: educator, reference @@ -31,16 +30,15 @@ keywords are not supported in discussion topics. .. _Prelaunch Reminder: -==================== Pre-launch Reminder -==================== +********************* Pre-launch reminders raise awareness of the course start date, publicize the course, and generate excitement. In addition to the course start date and time, the example that follows also lets learners know that: -* UTC is used in edX courses. Alternatively, you could include information - about your course or the edX platform that will contribute to your learners' +* UTC is used in Open edX courses. Alternatively, you could include information + about your course or the Open edX platform that will contribute to your learners' success. * The course has a companion social media site. Alternatively, you might @@ -50,7 +48,7 @@ the example that follows also lets learners know that: You may want to send out more than one message before the course launches: use this template as a starting point for crafting the different messages you want to deliver. Replace values enclosed by {braces} with information that applies -to your course. In addition, check that you are using :ref:`keywords <Use +to your course. In addition, check you are using :ref:`keywords <Use Keywords in Messages>` appropriately. :: @@ -59,10 +57,10 @@ Keywords in Messages>` appropriately. Hello %%USER_FULLNAME%%, - We are excited that you are joining us for {course number} - %%COURSE_DISPLAY_NAME%%, offered by {organization name} through edX. Class + We are excited you are joining us for {course number} + %%COURSE_DISPLAY_NAME%%, offered by {organization name}. Class begins on {day}, {date} at {time} UTC (which is {time} {local time zone}). - Note that many dates and times in edX courses appear in your local time zone, + Note that many dates and times in our courses appear in your local time zone, but some might appear in Coordinated Universal Time (UTC). Dates and times that use your local time zone are followed by an indication of the time zone: for example, 17:00 Sept. 5, 2016 IOT. UTC dates and times do not @@ -73,8 +71,8 @@ Keywords in Messages>` appropriately. Facebook page {add link}. You can find videos and photos posted there before the course even begins. - If this is your first edX course, consider enrolling in the edX Demo course - {add link}. This course gives you an opportunity to explore the edX platform + If this is your first course, consider enrolling in the Demo course + {add link}. This course gives you an opportunity to explore the platform and learn how to answer problems and track your progress, before {course number} begins. @@ -82,9 +80,8 @@ Keywords in Messages>` appropriately. .. _Launch Day Welcome: -=================== Launch Day Welcome -=================== +******************* On your course start date, you can send an email message that both welcomes learners and gives them specific actions to accomplish. This example directs @@ -98,7 +95,7 @@ personally introduces the course team leader. Search for the values enclosed by Hello everyone! - At this time, edX course {course number} is available from your Dashboard + At this time, the course {course number} is available from your Dashboard {add link}, and the staff would like to officially welcome you to the course! You'll find materials for the first week on the Course page, including both video lectures and problem sets. @@ -116,31 +113,30 @@ personally introduces the course team leader. Search for the values enclosed by .. _Verified Registration Reminder: -============================================== Reminder to Register for Verified Certificate -============================================== +********************************************** After your course has launched, you can send an email to remind learners that the last day to register for a verified certificate is approaching. You can use this template as a starting point for your own message; search for the values enclosed by {braces} and replace them with information for your course. In -addition, check that you are using :ref:`keywords <Use Keywords in Messages>` +addition, check you are using :ref:`keywords <Use Keywords in Messages>` appropriately. :: - Subject: Earn an edX verified certificate for {course name}! + Subject: Earn a verified certificate for {course name}! Dear %%USER_FULLNAME%%, - Interested in using an edX certificate to bolster a college application or to - advance your career? With an edX verified certificate, you can demonstrate to + Interested in using a certificate to bolster a college application or to + advance your career? With averified certificate, you can demonstrate to colleges, employers, and colleagues that you successfully completed a - challenging edX course, while helping to support the edX mission. + challenging course. We would like to remind you that {date} is the last day to register for a verified certificate in %%COURSE_DISPLAY_NAME%%. Registering for a - certificate is easy! Just go to this course on your edX dashboard and click + certificate is easy! Just go to this course on your dashboard and click "Challenge Yourself". Good luck! @@ -149,9 +145,8 @@ appropriately. .. _Weekly Highlights: -================== Weekly Highlights -================== +****************** Sending a weekly email to learners can be a great way to keep them engaged and provide encouragement. At the end of each week you might send learners an email @@ -164,7 +159,7 @@ You can use this template as a starting point for designing your own message, omitting the discussion highlights if they are not appropriate for your course (the example discussion highlights are from a course about urban solutions to the global water crisis). Search for the values enclosed by {braces} and -replace them with information for your course. In addition, check that you are +replace them with information for your course. In addition, check you are using :ref:`keywords <Use Keywords in Messages>` appropriately. :: @@ -196,9 +191,8 @@ using :ref:`keywords <Use Keywords in Messages>` appropriately. .. _Midcourse Encouragement: -======================== Mid-Course Encouragement -======================== +************************* While your course is running, you can send messages to promote community, remind learners of upcoming due dates, and address any recurring issues. @@ -208,7 +202,7 @@ and encourages contributions to the discussions. You may want to send out more than one message while the course is running. You can use this template as a starting point for your own messages; search for the values enclosed by {braces} and replace them with information for your course. In -addition, check that you are using :ref:`keywords <Use Keywords in Messages>` +addition, check you are using :ref:`keywords <Use Keywords in Messages>` appropriately. :: @@ -217,7 +211,7 @@ appropriately. Dear students, - We hope that you are learning a lot in {course number}! Remember that problem + We hope you are learning a lot in {course number}! Remember that problem set {number} is due on {date} at {time} UTC. You can always check the schedule {add link} on the Home page to plan ahead. @@ -242,9 +236,8 @@ appropriately. .. _Midcourse Events: -======================== Mid-Course Event -======================== +****************** Before an exam or other significant course event, messages can provide practical information about the exam, communicate expectations regarding @@ -266,7 +259,7 @@ completion. This example lets learners know: graders. Be sure to search for the values enclosed by {braces} and replace them with -information for your course. In addition, check that you are using +information for your course. In addition, check you are using :ref:`keywords <Use Keywords in Messages>` appropriately. :: @@ -286,7 +279,7 @@ information for your course. In addition, check that you are using * The exam starts on {date} at {time} UTC and must be finished by {date} at {time} UTC. Plan your schedule accordingly. - * Be sure that you know what time the UTC deadline is in your time zone. See + * Be sure you know what time the UTC deadline is in your time zone. See the current UTC time {add link}. No extensions will be given. * The exam is not timed. You can start, stop, and come back to it until the @@ -320,9 +313,8 @@ information for your course. In addition, check that you are using .. _Technical Issue: -======================== Technical Issue -======================== +***************** In the event of an unanticipated system failure, a message can both alert learners to the problem and reassure them that the issue is either resolved or @@ -330,7 +322,7 @@ being addressed. The message can also provide information about any changes made to the course as a result. Technical issues can arise during a course for many different reasons, so this -example is likely to need revision to apply to an issue that you encounter. +example is likely to need revision to apply to an issue you encounter. Keep in mind that to reassure the learners who are affected by the problem, the message should have a positive tone, and calmly and briefly identify the problem, the status of its solution, and any after effects. @@ -352,9 +344,8 @@ problem, the status of its solution, and any after effects. .. _Course Farewell and Certificates: -================================= Course Farewell and Certificates -================================= +********************************* In the last few days before your course ends, a message can direct learners to a course survey, answer questions about certificates, and provide information @@ -369,8 +360,8 @@ about future access to course materials. Be sure to replace values enclosed by Thank you for making %%COURSE_DISPLAY_NAME%% so much fun these last few months! We had a great time getting to know you through the course - discussions. We appreciate the effort that you put into this course, and we - hope that you enjoyed learning {subject} through edX. With or without a + discussions. We appreciate the effort you put into this course, and we + hope you enjoyed learning {subject}. With or without a certificate, you should be proud of your accomplishments. * Please take a few minutes to answer the exit survey, now available on the @@ -378,9 +369,9 @@ about future access to course materials. Be sure to replace values enclosed by future. * If you qualify for a certificate (overall score {number}% or higher), the - edX dashboard will include a link to your certificate in the near future. + dashboard will include a link to your certificate in the near future. While you may see the link in a few days, it can take up to two weeks for - edX to generate all of the course certificates. + platform to generate all of the course certificates. * As an enrolled student, you will have access to the lecture videos even after the course ends. Assessments will remain, but you will no longer be @@ -391,7 +382,7 @@ about future access to course materials. Be sure to replace values enclosed by continue viewing all of the conversations that took place during the course. - We hope that you share what you learned in {course number} with your + We hope you share what you learned in {course number} with your colleagues, friends, and family. Good luck on the final exam and beyond! @@ -400,9 +391,8 @@ about future access to course materials. Be sure to replace values enclosed by .. _New Course Run Announcement: -================================= New Course Run Announcement -================================= +***************************** When you prepare a course for a new run, you can use the bulk email feature in its previous run (or runs) to inform an engaged and knowledgeable audience: @@ -438,7 +428,7 @@ When preparing a message from this template, search for values enclosed by Perhaps you want to share the {course name} experience with a friend or colleague, earn an ID-verified certificate of achievement, or work through - course content that you weren't able to complete before. When {course number} + course content you weren't able to complete before. When {course number} is offered in {time frame}, we welcome you to join the community of learners again. diff --git a/source/educators/references/communication/learner_view_discussion.rst b/source/educators/references/communication/learner_view_discussion.rst index dd3837c70..dbe540c99 100644 --- a/source/educators/references/communication/learner_view_discussion.rst +++ b/source/educators/references/communication/learner_view_discussion.rst @@ -1,13 +1,12 @@ .. _A Students View of the Discussion: -********************************** A Learner's View of the Discussion -********************************** +################################### .. tags:: educator, reference When you add a discussion component to a unit, in the LMS, learners see only -the discussion, together with the display name of the discussion component, the category, and the subcategory. EdX recommends that you add an HTML +the discussion, together with the display name of the discussion component, the category, and the subcategory. The recommendation is to add an HTML component before each discussion component where you add some text to introduce the discussion topic. @@ -18,7 +17,7 @@ component. Learners select **Add a Post** to post their own contributions. :alt: An HTML text component and then a discussion component, as they appear in the LMS. -Content-specific topics that you add using discussion components are included +Content-specific topics you add using discussion components are included on the course **Discussion** page in the same way as course-wide discussion topics as included. In the following example, the category (1) and the subcategory (2) of the discussion component is shown in the list of @@ -27,4 +26,33 @@ discussion topics. .. image:: /_images/educator_how_tos/Discussion_category_subcategory.png :alt: The list of discussions on the Discussion page in the LMS, showing the category and subcategory of a content-specific discussion topic. - :width: 400 \ No newline at end of file + :width: 400 + +.. seealso:: + :class:dropdown + + :ref:`Discussions` (concept) + + :ref:`Running_discussions` (concept) + + :ref:`Moderating_discussions` (concept) + + :ref:`Guidance for Discussion Moderators` (concept) + + :ref:`Managing Divided Discussion Topics` (concept) + + :ref:`About Divided Discussions` (concept) + + :ref:`Assigning_discussion_roles` (how-to) + + :ref:`Configuring Edx Discussions` (how-to) + + :ref:`Administer Discussions` (how-to) + + :ref:`Closing Discussions` (how-to) + + :ref:`Set up Discussions in Cohorted Courses` (how-to) + + :ref:`Setting Up Divided Discussions` (how-to) + + :ref:`Working with Discussion Components` (how-to) \ No newline at end of file diff --git a/source/educators/references/course_development/about_course_wiki.rst b/source/educators/references/course_development/about_course_wiki.rst index 1348746aa..fec29c02d 100644 --- a/source/educators/references/course_development/about_course_wiki.rst +++ b/source/educators/references/course_development/about_course_wiki.rst @@ -1,8 +1,7 @@ .. _About Course Wiki: -*********************** About the Course Wiki -*********************** +###################### .. tags:: educator, reference @@ -29,10 +28,6 @@ contribute to a repository of information about your course that can be immediately useful to other learners, or useful for you and your course team as you develop other courses or future runs of the same course. -The wiki for each course is a "child" wiki of the edX-wide wiki. From within -any course wiki, select the top level **Wiki** link in the breadcrumb trail -at the top of the page to visit the edX-wide wiki. - .. Some courses have linked wikis, which can be useful for course re-runs or for course series. You link a wiki with another course's wiki by...? .. _Wikis Overview: From e5500a5e25318a8188dab44f152b94525c7ea12a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Mon, 13 Jan 2025 17:09:20 -0500 Subject: [PATCH 02/12] Update compose_email_message.rst --- .../communication/compose_email_message.rst | 29 +++++++++---------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/source/educators/references/communication/compose_email_message.rst b/source/educators/references/communication/compose_email_message.rst index 0d4c4bfc3..e210b8ca4 100644 --- a/source/educators/references/communication/compose_email_message.rst +++ b/source/educators/references/communication/compose_email_message.rst @@ -22,7 +22,7 @@ For more information, see :ref:`Working with Text Components<working with text c Restricted HTML Content ======================== -The Bulk Course Email tool restricts use of specific HTML elements from being +The Bulk Course Email tool restricts the use of specific HTML elements from being used in messages. The following HTML elements may not be used in messages authored with this tool: @@ -31,17 +31,17 @@ authored with this tool: * form * script -.. note:: If a message contains restricted HTML content it will **not** be +.. note:: If a message contains restricted HTML content, it will **not** be stripped from the message. The HTML code will be converted to plain text. You - should send a test message to yourself first before sending to larger groups + should send a test message to yourself before sending it to larger groups to ensure message content is displayed as desired. Images ******** -Messages can include images. To include an image, you must first add the file -to your course on the **Files & Uploads** page. For an email message, you copy +Messages can include images. You must first add the file +to your course on the **Files & Uploads** page to include an image. For an email message, you copy the **Web** URL that the system assigns to the image. Then, in the email message editor, you select the **Insert/edit image** icon to add the web URL. @@ -62,30 +62,27 @@ For more information, see :ref:`Add Files to a Course`. Keywords ********* -Messages can include variables that represent values that are specific to each -message recipient, such as learner name or user ID. The LMS substitutes these +Messages can include variables representing values specific to each +recipient, such as learner name or user ID. The LMS substitutes these variables, called keywords, with actual values when it sends a message. -For more information, see :ref:`Use Keywords in Messages`. - .. _Use Keywords in Messages: -**************************** Use Keywords in Messages -**************************** +======================== You can include keywords in your messages. A keyword is a variable: when you -send the message, a value that is specific to the each recipient is substituted +send the message, a value specific to each recipient is substituted for the keyword. For example, when you use the ``%%USER_FULLNAME%%`` keyword, -each message contains the name of the recipient. +each message contains the recipient's name. .. note:: Do not use keywords in the Subject line of a message. The keyword in the subject will not be assigned a value, and the recipient will see the keyword text. -=================== + Supported Keywords =================== @@ -96,7 +93,7 @@ You can use the following keywords in your messages. * ``%%COURSE_DISPLAY_NAME%%`` - the display name of the course * ``%%COURSE_END_DATE%%`` - the end date of the course -=================== + Keyword Formatting =================== @@ -124,4 +121,4 @@ tags in an email message. An example follows. :ref:`Email Task History Report` (how-to) :ref:`Example Messages to Students` (reference) - \ No newline at end of file + From de2538b4a4dc385bf963752379577610e05628be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:14:00 -0500 Subject: [PATCH 03/12] Update source/educators/how-tos/course_development/additional_video_options.rst Co-authored-by: Sarina Canelake <sarina@axim.org> --- .../how-tos/course_development/additional_video_options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/how-tos/course_development/additional_video_options.rst b/source/educators/how-tos/course_development/additional_video_options.rst index 4687b6e6b..9e5cd69c3 100644 --- a/source/educators/how-tos/course_development/additional_video_options.rst +++ b/source/educators/how-tos/course_development/additional_video_options.rst @@ -1,6 +1,6 @@ .. _Additional Video Options: -Specifying Additional Video Options +Specify Additional Video Options ################################### .. tags:: educator, how-to From 6fcccca792783c85c758bde0ab542312e5bab6a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:14:22 -0500 Subject: [PATCH 04/12] Update source/educators/how-tos/course_development/create_discussion.rst Co-authored-by: Sarina Canelake <sarina@axim.org> --- .../educators/how-tos/course_development/create_discussion.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/how-tos/course_development/create_discussion.rst b/source/educators/how-tos/course_development/create_discussion.rst index a0f386e09..24cc02040 100644 --- a/source/educators/how-tos/course_development/create_discussion.rst +++ b/source/educators/how-tos/course_development/create_discussion.rst @@ -10,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 you create by adding discussion components in your +Discussion topics that you create by adding discussion components in your course are known as content-specific discussion topics. For more information about discussions, see these topics. From f89f34268f7953f8d60802980b473ffd4bbfc65f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:19:35 -0500 Subject: [PATCH 05/12] Update source/educators/references/communication/bulk_email.rst Co-authored-by: Sarina Canelake <sarina@axim.org> --- source/educators/references/communication/bulk_email.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/communication/bulk_email.rst b/source/educators/references/communication/bulk_email.rst index 4a70a4e4e..e9c413ece 100644 --- a/source/educators/references/communication/bulk_email.rst +++ b/source/educators/references/communication/bulk_email.rst @@ -84,7 +84,7 @@ should be aware of who is included in each group. selected, the Open edX platform will only send email messages to learners in a course run who have logged in within the last 18 months. This helps reduce the risk of messages being marked as spam (or bouncing) and helps ensure the continued - delivery of bulk course email messages through Open edX's email providers. + delivery of bulk course email messages through your instance's email providers. .. list-table:: :widths: 30 40 40 From a9aa48f5d6fe71c35e7ad67f5c5814ccab15c627 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:19:49 -0500 Subject: [PATCH 06/12] Update source/educators/references/communication/compose_email_message.rst Co-authored-by: Sarina Canelake <sarina@axim.org> --- .../references/communication/compose_email_message.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/communication/compose_email_message.rst b/source/educators/references/communication/compose_email_message.rst index e210b8ca4..e127a1eb0 100644 --- a/source/educators/references/communication/compose_email_message.rst +++ b/source/educators/references/communication/compose_email_message.rst @@ -54,7 +54,7 @@ To ensure your course assets are transmitted securely, add the :: - https://courses.openedx.org/asset-v1:{course}.x+{run}+type@asset+block@{image}.jpg + https://courses.myinstance.com/asset-v1:{course}.x+{run}+type@asset+block@{image}.jpg For more information, see :ref:`Add Files to a Course`. From d7530fd8f3eed4a9635ec6d2d6db6a899a3b3d70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:19:57 -0500 Subject: [PATCH 07/12] Update source/educators/references/communication/example_bulk_emails.rst Co-authored-by: Sarina Canelake <sarina@axim.org> --- .../educators/references/communication/example_bulk_emails.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/communication/example_bulk_emails.rst b/source/educators/references/communication/example_bulk_emails.rst index 644d21af3..7e8a78512 100644 --- a/source/educators/references/communication/example_bulk_emails.rst +++ b/source/educators/references/communication/example_bulk_emails.rst @@ -159,7 +159,7 @@ You can use this template as a starting point for designing your own message, omitting the discussion highlights if they are not appropriate for your course (the example discussion highlights are from a course about urban solutions to the global water crisis). Search for the values enclosed by {braces} and -replace them with information for your course. In addition, check you are +replace them with information for your course. In addition, check that you are using :ref:`keywords <Use Keywords in Messages>` appropriately. :: From 9731580822b34daf65d5c851d6cdaac04c26fe02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:20:04 -0500 Subject: [PATCH 08/12] Update source/educators/references/communication/example_bulk_emails.rst Co-authored-by: Sarina Canelake <sarina@axim.org> --- .../educators/references/communication/example_bulk_emails.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/communication/example_bulk_emails.rst b/source/educators/references/communication/example_bulk_emails.rst index 7e8a78512..1ec184490 100644 --- a/source/educators/references/communication/example_bulk_emails.rst +++ b/source/educators/references/communication/example_bulk_emails.rst @@ -202,7 +202,7 @@ and encourages contributions to the discussions. You may want to send out more than one message while the course is running. You can use this template as a starting point for your own messages; search for the values enclosed by {braces} and replace them with information for your course. In -addition, check you are using :ref:`keywords <Use Keywords in Messages>` +addition, check that you are using :ref:`keywords <Use Keywords in Messages>` appropriately. :: From 4906cf1827f4eb90259a0abf55a8e2a8f1e630c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:20:12 -0500 Subject: [PATCH 09/12] Update source/educators/references/communication/example_bulk_emails.rst Co-authored-by: Sarina Canelake <sarina@axim.org> --- .../educators/references/communication/example_bulk_emails.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/communication/example_bulk_emails.rst b/source/educators/references/communication/example_bulk_emails.rst index 1ec184490..d90f3b4ec 100644 --- a/source/educators/references/communication/example_bulk_emails.rst +++ b/source/educators/references/communication/example_bulk_emails.rst @@ -259,7 +259,7 @@ completion. This example lets learners know: graders. Be sure to search for the values enclosed by {braces} and replace them with -information for your course. In addition, check you are using +information for your course. In addition, check that you are using :ref:`keywords <Use Keywords in Messages>` appropriately. :: From 5dd859753b30608840b41b5040f85f6a498f91ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:20:22 -0500 Subject: [PATCH 10/12] Update source/educators/references/communication/example_bulk_emails.rst Co-authored-by: Sarina Canelake <sarina@axim.org> --- .../educators/references/communication/example_bulk_emails.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/educators/references/communication/example_bulk_emails.rst b/source/educators/references/communication/example_bulk_emails.rst index d90f3b4ec..926325943 100644 --- a/source/educators/references/communication/example_bulk_emails.rst +++ b/source/educators/references/communication/example_bulk_emails.rst @@ -371,7 +371,7 @@ about future access to course materials. Be sure to replace values enclosed by * If you qualify for a certificate (overall score {number}% or higher), the dashboard will include a link to your certificate in the near future. While you may see the link in a few days, it can take up to two weeks for - platform to generate all of the course certificates. + all of the course certificates to be generated. * As an enrolled student, you will have access to the lecture videos even after the course ends. Assessments will remain, but you will no longer be From db8ba04d5d45e478b39726b5568c842f25c949ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:22:24 -0500 Subject: [PATCH 11/12] Update about_course_wiki.rst --- .../course_development/about_course_wiki.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/source/educators/references/course_development/about_course_wiki.rst b/source/educators/references/course_development/about_course_wiki.rst index fec29c02d..82e63a6a5 100644 --- a/source/educators/references/course_development/about_course_wiki.rst +++ b/source/educators/references/course_development/about_course_wiki.rst @@ -25,11 +25,15 @@ Common uses for the course wiki might include the following activities. As learners and course team members create and edit wiki articles, they contribute to a repository of information about your course that can be -immediately useful to other learners, or useful for you and your course team as +immediately useful to other learners or useful for you and your course team as you develop other courses or future runs of the same course. .. Some courses have linked wikis, which can be useful for course re-runs or for course series. You link a wiki with another course's wiki by...? +The wiki for each course is a "child" wiki of the single wiki that exists for your +whole instance. From within any course wiki, select the top-level **Wiki** link +in the breadcrumb trail at the top of the page to visit the instance-wide wiki. + .. _Wikis Overview: ******************************** @@ -38,10 +42,10 @@ Managing the Course Wiki Keep these points in mind as you design the wiki for your course. -* Be clear about the purpose for the wiki or for different parts of the wiki. +* Be clear about the wiki's purpose or for different parts of the wiki. For example, are some parts of the wiki only for disseminating information? - If that is the case, then make sure that only your course team has write - access for those articles. + If so, ensure that only your course team has written + access to those articles. * Decide whether some parts of the wiki are intended for learner collaboration or learner input. Make sure that learners are able to create and edit wiki @@ -49,7 +53,7 @@ Keep these points in mind as you design the wiki for your course. these pages can be edited. * Think about the different tasks that will be performed by people in different - roles. Typically you want your course team to have some privileges that + roles. Typically, you want your course team to have some privileges that learners do not have. For example, course team members can delete wiki articles, but learners cannot. From b8a405fff8f3ef31e16cf3d302b1f1a3335601f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ana=20Paula=20G=C3=B3mez?= <131492787+Apgomeznext@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:57:46 -0500 Subject: [PATCH 12/12] Update email_task_history_report.rst --- .../how-tos/communication/email_task_history_report.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/educators/how-tos/communication/email_task_history_report.rst b/source/educators/how-tos/communication/email_task_history_report.rst index 868e90ce3..7e5969b5e 100644 --- a/source/educators/how-tos/communication/email_task_history_report.rst +++ b/source/educators/how-tos/communication/email_task_history_report.rst @@ -1,7 +1,7 @@ .. _Email Task History Report: -Email Task History Report -########################### +How to Use the Email Task History Report +########################################### .. tags:: educator, how-to @@ -80,4 +80,4 @@ Failure. :ref:`Options for Email Message Text` (reference) - \ No newline at end of file +