Skip to content

Commit e931ef2

Browse files
committed
docs: Minor updates in Readme
1 parent c672f2a commit e931ef2

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
notifications plugin for `Tutor <https://docs.tutor.edly.io>`__
1+
Notifications plugin for `Tutor <https://docs.tutor.edly.io>`__
22
###############################################################
33

4-
A Tutor plugin to manage configuration and plugin slots for the Notifications tray feature.
4+
A Tutor plugin to manage plugin slot and configuration for tray and email notifications feature. Learn
5+
more about it in
6+
:ref:`Notifications & Preferences <https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/managing_notifications/index.html>`.
57

68

79
Installation
@@ -17,10 +19,12 @@ Usage
1719
.. code-block:: bash
1820
1921
tutor plugins enable notifications
22+
23+
2024
Configuration
2125
*************
2226

23-
The plugin exposes the following Tutor configuration keys :
27+
The plugin exposes the following Tutor configuration keys:
2428
- ``NOTIFICATIONS_DEFAULT_FROM_EMAIL``
2529
- Default: inherits from the platform `CONTACT_EMAIL`.
2630
- Purpose: sets the default "from" address used when sending notification emails.
@@ -32,10 +36,13 @@ The plugin exposes the following Tutor configuration keys :
3236
After changing configuration,restart environment so the new environment variable and settings are picked up by the LMS and MFE images.
3337
If you rely on a specific "from" email for outgoing notifications, explicitly set ``NOTIFICATIONS_DEFAULT_FROM_EMAIL`` rather than relying on the platform-wide ``CONTACT_EMAIL``.
3438

39+
Visibility of email notification preferences in the Notifications section on the Account Settings
40+
page is governed by the `NOTIFICATIONS_ENABLE_SHOW_EMAIL_CHANNEL` setting. It is TRUE by default.
41+
42+
Visibility of mobile push notification preferences in the Notifications section on the Account Settings
43+
page is governed by the `NOTIFICATIONS_ENABLE_SHOW_PUSH_CHANNEL`. It is FALSE by default because we do
44+
NOT have support for mobile push notifications at the moment.
3545

36-
The email and push notification settings under Account can be enabled/disabled using `NOTIFICATIONS_ENABLE_SHOW_EMAIL_CHANNEL`
37-
and `NOTIFICATIONS_ENABLE_SHOW_PUSH_CHANNEL`. `NOTIFICATIONS_ENABLE_SHOW_EMAIL_CHANNEL` is set to True while `NOTIFICATIONS_ENABLE_SHOW_PUSH_CHANNEL`
38-
is set to False by default.
3946

4047
License
4148
*******

0 commit comments

Comments
 (0)