Skip to content

Docs: Minor updates in Readme #49

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.

Sign up for GitHub

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

Merged
bmtcril merged 3 commits into from
Dec 19, 2025
Merged

Docs: Minor updates in Readme #49

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e931ef2
docs: Minor updates in Readme
ayub02 Dec 18, 2025
9646d1d
docs: corrected link to notifications & preferences page
ayub02 Dec 19, 2025
8d8ef0a
fix: RST syntax for hyperlink
sarina Dec 19, 2025
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
19 changes: 13 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
notifications plugin for `Tutor <https://docs.tutor.edly.io>`__
Notifications plugin for `Tutor <https://docs.tutor.edly.io>`__
###############################################################

A Tutor plugin to manage configuration and plugin slots for the Notifications tray feature.
A Tutor plugin to manage plugin slot and configuration for tray and email notifications feature. Learn
more about it in
`Notifications & Preferences <https://docs.openedx.org/en/latest/learners/sfd_notifications/index.html>`_


Installation
Expand All @@ -17,10 +19,12 @@ Usage
.. code-block:: bash

tutor plugins enable notifications


Configuration
*************

The plugin exposes the following Tutor configuration keys :
The plugin exposes the following Tutor configuration keys:
- ``NOTIFICATIONS_DEFAULT_FROM_EMAIL``
- Default: inherits from the platform `CONTACT_EMAIL`.
- Purpose: sets the default "from" address used when sending notification emails.
Expand All @@ -32,10 +36,13 @@ The plugin exposes the following Tutor configuration keys :
After changing configuration,restart environment so the new environment variable and settings are picked up by the LMS and MFE images.
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``.

Visibility of email notification preferences in the Notifications section on the Account Settings
page is governed by the `NOTIFICATIONS_ENABLE_SHOW_EMAIL_CHANNEL` setting. It is TRUE by default.

Visibility of mobile push notification preferences in the Notifications section on the Account Settings
page is governed by the `NOTIFICATIONS_ENABLE_SHOW_PUSH_CHANNEL`. It is FALSE by default because we do
NOT have support for mobile push notifications at the moment.

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

License
*******
Expand Down