Merge pull request #1637 from edx/sylvia/DOC-3859

Add info about discussion notifications to ICR guide

en_us/course_authors/source/manage_live_course/automatic_email.rst

@@ -1 +1,200 @@
-.. include:: ../../../shared/manage_live_course/automatic_email.rst
+.. _Automatic Email:
+
+#################################
+Automatic Email Messages from edX
+#################################
+
+.. Note: Any update to the **discussion notification** information should also
+.. 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
+of automatic email messages.
+
+.. list-table::
+ :widths: 20 10 20 50
+ :header-rows: 1
+
+ * - Email Type
+   - Course Pacing
+   - Day Sent
+   - Description
+ * - :ref:`Day 3 Nudge Message`
+   - Self-paced
+   - 3 days after enrollment
+   - Single message that welcomes and encourages the learner to return to the
+     course. Includes an upsell message if the learner has not enrolled in the
+     verified track.
+ * - :ref:`Day 10 Nudge Message`
+   - Self-paced
+   - 10 days after enrollment
+   - Single message that encourages the learner to return to the course.
+     Includes an upsell message if the learner has not enrolled in the verified
+     track. Is not sent if the learner receives a :ref:`weekly course
+     highlight message <Weekly Course Highlight Message>` on day 7.
+ * - :ref:`Day 19 Upgrade Reminder`
+   - Self-paced
+   - 19 days after enrollment or 2 days before upgrade
+     deadline
+   - Reminder to upgrade if the learner hasn't enrolled in the verified track.
+     Is not sent if the learner receives :ref:`weekly course highlight messages
+     <Weekly Course Highlight Message>`.
+ * - :ref:`Weekly Course Highlight Message<Weekly Course Highlight Message>`
+   - Self-paced
+   - Every 7 days after enrollment
+   - Weekly message that lists 3-5 highlights for the
+     next course "week", or section. Is not sent if the course team has not
+     added highlights for the section in Studio. For more information, see
+     :ref:`Set Section Highlights for Weekly Course Highlight Messages`.
+ * - :ref:`Discussion Notification`
+   - Instructor-paced and self-paced
+   - Unspecified
+   - Notifications that a user has responded to a post on a :ref:`course
+     discussion<Managing Discussions Index>`.
+
+*****************************
+Automatic Email Message Text
+*****************************
+
+The following example messages show the text of the email messages that edX
+sends to learners automatically.
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. _Day 3 Nudge Message:
+
+===================
+Day 3 Nudge Message
+===================
+
+EdX sends the following message three days after a learner enrolls in a course.
+::
+
+  Subject: Keep learning in Creating a Course with edX Studio!
+
+  Remember when you enrolled in Creating a Course with edX Studio on edX.org?
+  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.
+
+::
+
+  Subject: Keep learning on edX!
+
+  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
+  is learning.
+
+.. _Day 10 Nudge Message:
+
+====================
+Day 10 Nudge Message
+====================
+
+.. note::
+ If learners receive a weekly 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.
+
+::
+
+  Subject: Keep up the momentum!
+
+  Many edX learners in Creating a Course with edX Studio 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.
+
+::
+
+  Subject: Keep up the momentum!
+
+  Many edX 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:
+
+========================
+Day 19 Upgrade Reminder
+========================
+
+.. note::
+ If learners receive :ref:`weekly course highlight messages<Weekly Course
+ Highlight Message>`, they do not receive this upgrade reminder.
+
+EdX 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
+
+  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.
+
+  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.
+
+::
+
+  Subject: Upgrade to earn a verified certificate on edX
+
+  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
+  certificate is official and easily shareable.
+
+  Upgrade by November 25, 2017.
+
+.. _Weekly Course Highlight Message:
+
+================================
+Weekly Highlight Email
+================================
+
+EdX sends the following message every seven days after a learner enrolls in a
+course. For more information, see :ref:`Set Section Highlights for Weekly
+Course Highlight Messages`.
+
+.. include:: ../../../shared/developing_course/course_highlight_message_text.rst
+
+.. _Discussion Notification:
+
+================================
+Discussion Notification
+================================
+
+.. Note: Any update to the **discussion notification** information should also
+.. be made to the manage_live_course/automatic_email.rst file in the Open edX
+.. course authors guide.
+
+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.
+
+::
+
+  Subject: Response to <title of post>
+
+  <edX 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.
+However, the learner automatically receives a daily digest email message that
+summarizes additional activity on the post. For more information, see
+:ref:`learners:Receiving Discussion Notifications` and
+:ref:`learners:Receiving Daily Digests`.

en_us/install_operations/source/configuration/enable_discussion_notifications.rst

@@ -0,0 +1,63 @@
+.. _Enabling Discussion Notifications:
+
+##########################################
+Enabling Discussion Notifications
+##########################################
+
+You can set up notifications that learners receive the first time that anyone
+adds a response to a discussion post that they have made.
+
+For more information, including the text of the discussion notification
+message, see :ref:`opencoursestaff:Automatic Email` and
+:ref:`openlearners:Receiving Discussion Notifications`.
+
+.. contents::
+   :depth: 1
+   :local:
+
+.. _Requirements for Discussion Notifications:
+
+*****************************************
+Requirements for Discussion Notifications
+*****************************************
+
+To create discussion notifications for your instance of the Open edX platform,
+you need the following items.
+
+* edX Automated Communication Engine (ACE). For more information about how to
+  install and configure ACE, see `edX Automated Communication Engine`_.
+* A third party email client, such as Sailthru. For information about how to
+  configure your email client, see the documentation for the client.
+
+.. _Enable Discussion Notifications:
+
+*******************************
+Enable Discussion Notifications
+*******************************
+
+After you have set up ACE and the third party email client, you enable
+discussion notifications in the Django administration console for your instance
+of Open edX.
+
+#. Sign in to the LMS Django administration console for your base URL. For
+   example, ``http://{your_URL}/admin``.
+
+#. On the **Site Administration** page, locate **Site_Configuration**.
+
+#. In the **Site_Configuration** section, next to **Site configurations**,
+   select **Change**.
+
+#. On the **Change site configuration** page, locate the **Values** field, and
+   then add the following value.
+
+   ::
+
+     {
+      "enable_forum_notifications":true
+      }
+
+#. Select **Save**.
+
+
+
+.. include:: ../../../links/links.rst

en_us/install_operations/source/configuration/index.rst

@@ -21,6 +21,7 @@ configuration options.
    enable_certificates
    enable_pacing
    enable_ccx
+   enable_discussion_notifications
    enable_entrance_exams
    ora2/index
    enable_prerequisites

en_us/links/links.rst

@@ -558,3 +558,5 @@
 .. _List of ISO 639-1 codes: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
 
 .. _Proctoring Software System Requirements: http://clientportal.softwaresecure.com/support/index.php?/Knowledgebase/Article/View/252/0/system-requirements-remote-proctor-now
+
+.. _edX Automated Communication Engine: http://edx-ace.readthedocs.io/en/latest

en_us/open_edx_course_authors/source/manage_live_course/automatic_email.rst

@@ -0,0 +1,51 @@
+.. _Automatic Email:
+
+###################################################
+Automatic Email Messages from the Open edX Platform
+###################################################
+
+.. Currently (5 January 2018), edx.org sends several different automatic
+.. messages to learners. Those messages are listed in the partner version of
+.. this topic. Open edX only sends discussion notifications. This topic was
+.. created to mirror the partner topic and to provide a place to add any
+.. additional messages that become available on Open edX.
+
+.. Any update to this information should also be made to the
+.. manage_live_course/automatic_email.rst file in the partner course authors
+.. guide.
+
+
+To help learners become and remain engaged in a course, the Open edX platform
+can send automatic email messages that notify learners of responses to
+discussion posts.
+
+.. note::
+  Before the system can send automatic email messages for any courses, a system
+  administrator must enable automatic messages on the instance of the Open edX
+  platform. For more information, see :ref:`installation:Enable Discussion
+  Notifications`.
+
+*****************************
+Automatic Email Message Text
+*****************************
+
+After a learner or course team member creates a post in the course discussions,
+the platform sends the following email message the first time a learner or
+course team member replies to the original post.
+
+::
+
+  Subject: Response 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.
+
+The platform does not send individual messages for any additional replies on
+the post. However, the learner automatically receives a daily digest email
+message that summarizes additional activity on the post. For more information,
+see :ref:`openlearners:Receiving Discussion Notifications` and
+:ref:`openlearners:Receiving Daily Digests`.

en_us/open_edx_course_authors/source/manage_live_course/index.rst

@@ -12,6 +12,7 @@ email to learners in the course.
    :maxdepth: 2
 
    course_data
+   automatic_email
    bulk_email
    course_enrollment
    staff_debug_info