From 570a0c185d3c5007ba73a84ae4a10f5e7b5b3abe Mon Sep 17 00:00:00 2001 From: Vishwajit Pravinkumar Herma Date: Fri, 8 May 2026 11:56:12 +0530 Subject: [PATCH 1/7] docs: Update enable_notifications.rst with initialization details Clarified the initialization step required after enabling the notifications plugin, including the necessary command and environment variables. --- .../site_ops/how-tos/enable_notifications.rst | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/source/site_ops/how-tos/enable_notifications.rst b/source/site_ops/how-tos/enable_notifications.rst index 463070ef0..50d0dbc1b 100644 --- a/source/site_ops/how-tos/enable_notifications.rst +++ b/source/site_ops/how-tos/enable_notifications.rst @@ -32,17 +32,25 @@ 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 - - ``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:: From bde82ca79bec4119bb5787f2f63448d55d2fb780 Mon Sep 17 00:00:00 2001 From: Vishwajit Pravinkumar Herma Date: Fri, 8 May 2026 12:02:48 +0530 Subject: [PATCH 2/7] docs: Update instructions for enabling notifications plugin Clarify the requirement to perform the initialization task before rebuilding the MFE image. --- source/site_ops/how-tos/enable_notifications.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/site_ops/how-tos/enable_notifications.rst b/source/site_ops/how-tos/enable_notifications.rst index 50d0dbc1b..b6a7bb146 100644 --- a/source/site_ops/how-tos/enable_notifications.rst +++ b/source/site_ops/how-tos/enable_notifications.rst @@ -54,7 +54,7 @@ When enabled, the plugin requires an **initialization step** to enable notificat .. important:: - After enabling the notifications plugin, site operators **must rebuild the + After enabling the notifications plugin and doing initialisation task as mentioned above, site operators **must rebuild the MFE image** for the notification tray to appear in the user interface. Rebuild the MFE image: From dfab41697aabe3b7b5aad3c2a8f0b1c5baeede7e Mon Sep 17 00:00:00 2001 From: Vishwajit Pravinkumar Herma Date: Fri, 8 May 2026 12:07:45 +0530 Subject: [PATCH 3/7] docs: Update instructions for enabling notifications plugin Clarified the wording regarding the initialization step for enabling notifications. --- source/site_ops/how-tos/enable_notifications.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/site_ops/how-tos/enable_notifications.rst b/source/site_ops/how-tos/enable_notifications.rst index b6a7bb146..268988ddf 100644 --- a/source/site_ops/how-tos/enable_notifications.rst +++ b/source/site_ops/how-tos/enable_notifications.rst @@ -54,8 +54,7 @@ When enabled, the plugin requires an **initialization step** to enable notificat .. important:: - After enabling the notifications plugin and doing initialisation task as mentioned above, 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: From 6f14fe3508c6499d48513b9d2c8b9a7952f148a0 Mon Sep 17 00:00:00 2001 From: Vishwajit Pravinkumar Herma Date: Mon, 11 May 2026 09:56:16 +0530 Subject: [PATCH 4/7] docs: Clarify initialization steps for notifications plugin Updated the steps for enabling notifications plugin to clarify the initialization process and added details about required commands. --- .../site_ops/how-tos/enable_notifications.rst | 36 +++++++++---------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/source/site_ops/how-tos/enable_notifications.rst b/source/site_ops/how-tos/enable_notifications.rst index 268988ddf..9911b9553 100644 --- a/source/site_ops/how-tos/enable_notifications.rst +++ b/source/site_ops/how-tos/enable_notifications.rst @@ -32,35 +32,33 @@ Enable the plugin in your Tutor environment: tutor plugins enable notifications -When enabled, the plugin requires an **initialization step** to enable notifications: +When enabled, the plugin requires two additional steps to fully set up notifications: -- 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: +1. **Initialize notifications plugin** - .. code-block:: bash + Run **one** of the following commands, depending on your deployment environment: - tutor dev [do/local/k8s] init --limit notifications + .. code-block:: bash - This step ensures that the following are set: + tutor local do init --limit=notifications + tutor k8s do init --limit=notifications - - The waffle flags: + This configures the required waffle flags and environment variables: - - ``notifications.enable_notifications`` - - ``notifications.enable_email_notifications`` + - Waffle flags: + - ``notifications.enable_notifications`` + - ``notifications.enable_email_notifications`` + - Environment variables: + - ``SHOW_EMAIL_CHANNEL`` (defaults to TRUE) + - ``SHOW_PUSH_CHANNEL`` (defaults to FALSE) - - The required environment variables for the notifications service: +2. **Rebuild the MFE image** - - ``SHOW_EMAIL_CHANNEL`` (defaults to TRUE) - - ``SHOW_PUSH_CHANNEL`` (defaults to FALSE) + After initialization, rebuild the MFE image so the notification tray appears: -.. important:: - - 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: - -.. code-block:: bash + .. code-block:: bash - tutor images build mfe + tutor images build mfe Configure the notifications plugin From 2ac57567cf48a7f431602de15a67276dabcbc19e Mon Sep 17 00:00:00 2001 From: Vishwajit Pravinkumar Herma Date: Mon, 11 May 2026 20:03:11 +0530 Subject: [PATCH 5/7] Update source/site_ops/how-tos/enable_notifications.rst Co-authored-by: Sara Burns --- source/site_ops/how-tos/enable_notifications.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/site_ops/how-tos/enable_notifications.rst b/source/site_ops/how-tos/enable_notifications.rst index 9911b9553..6f8fb56c6 100644 --- a/source/site_ops/how-tos/enable_notifications.rst +++ b/source/site_ops/how-tos/enable_notifications.rst @@ -40,7 +40,7 @@ When enabled, the plugin requires two additional steps to fully set up notificat .. code-block:: bash - tutor local do init --limit=notifications + tutor [local/dev/k8s] do init --limit=notifications tutor k8s do init --limit=notifications This configures the required waffle flags and environment variables: From 9bf9e40e03eab95e1c6da3514a6a33d144afff04 Mon Sep 17 00:00:00 2001 From: Vishwajit Pravinkumar Herma Date: Mon, 11 May 2026 20:03:23 +0530 Subject: [PATCH 6/7] Update source/site_ops/how-tos/enable_notifications.rst Co-authored-by: Sara Burns --- source/site_ops/how-tos/enable_notifications.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/site_ops/how-tos/enable_notifications.rst b/source/site_ops/how-tos/enable_notifications.rst index 6f8fb56c6..fd6c9dbd4 100644 --- a/source/site_ops/how-tos/enable_notifications.rst +++ b/source/site_ops/how-tos/enable_notifications.rst @@ -36,7 +36,7 @@ When enabled, the plugin requires two additional steps to fully set up notificat 1. **Initialize notifications plugin** - Run **one** of the following commands, depending on your deployment environment: + Run the following command: .. code-block:: bash From ea1de883eb9201050a9d5278d137e063455cf8f0 Mon Sep 17 00:00:00 2001 From: Vishwajit Pravinkumar Herma Date: Mon, 11 May 2026 20:03:32 +0530 Subject: [PATCH 7/7] Update source/site_ops/how-tos/enable_notifications.rst Co-authored-by: Sara Burns --- source/site_ops/how-tos/enable_notifications.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/site_ops/how-tos/enable_notifications.rst b/source/site_ops/how-tos/enable_notifications.rst index fd6c9dbd4..7d8d0cb39 100644 --- a/source/site_ops/how-tos/enable_notifications.rst +++ b/source/site_ops/how-tos/enable_notifications.rst @@ -41,7 +41,7 @@ When enabled, the plugin requires two additional steps to fully set up notificat .. code-block:: bash tutor [local/dev/k8s] do init --limit=notifications - tutor k8s do init --limit=notifications + This configures the required waffle flags and environment variables: