Skip to content

docs: Update enable_notifications.rst with initialization details #1452

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

Open
Vishwajit-Herma wants to merge 3 commits into
base: main
Choose a base branch
from
+16 −9
Open

docs: Update enable_notifications.rst with initialization details #1452

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
570a0c1
docs: Update enable_notifications.rst with initialization details
Vishwajit-Herma May 8, 2026
bde82ca
docs: Update instructions for enabling notifications plugin
Vishwajit-Herma May 8, 2026
dfab416
docs: Update instructions for enabling notifications plugin
Vishwajit-Herma May 8, 2026
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
25 changes: 16 additions & 9 deletions source/site_ops/how-tos/enable_notifications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,29 @@ Enable the plugin in your Tutor environment:

tutor plugins enable notifications

When enabled, the plugin automatically:
When enabled, the plugin requires an **initialization step** to enable notifications:

- Enables the following waffle flags:
- After enabling the plugin, you must run the following command to properly set up waffle flags and environment variables for the notifications service. Replace `[do/local/k8s]` with the appropriate option for your deployment environment:

- ``notifications.enable_notifications``
- ``notifications.enable_email_notifications``
.. code-block:: bash

- Sets the required environment variables for the notifications service
tutor dev [do/local/k8s] init --limit notifications
Copy link
Copy Markdown

@musaabhasan musaabhasan May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This command reads as if dev is fixed and [do/local/k8s] is the placeholder, which would lead operators to run an invalid Tutor command. Existing Tutor patterns use the environment first, then the action, for example tutor local do init --limit=notifications or tutor k8s do init --limit=notifications. I would replace this with two explicit examples rather than a nested placeholder.


- ``SHOW_EMAIL_CHANNEL`` (defaults to TRUE)
- ``SHOW_PUSH_CHANNEL`` (defaults to FALSE)
This step ensures that the following are set:

- The waffle flags:

- ``notifications.enable_notifications``
- ``notifications.enable_email_notifications``

- The required environment variables for the notifications service:

- ``SHOW_EMAIL_CHANNEL`` (defaults to TRUE)
- ``SHOW_PUSH_CHANNEL`` (defaults to FALSE)

.. important::
Copy link
Copy Markdown

@musaabhasan musaabhasan May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line has extra spacing before notification and is now long enough to be hard to scan in the rendered source. It would also be clearer to separate the sequence into two explicit steps: initialize the notifications plugin first, then rebuild the MFE image so the notification tray is visible.


After enabling the notifications plugin, site operators **must rebuild the
MFE image** for the notification tray to appear in the user interface.
After enabling the notifications plugin and completing the initialization step as mentioned above, site operators must rebuild the MFE image for the notification tray to appear in the user interface.

Rebuild the MFE image:

Expand Down