@@ -32,28 +32,33 @@ Enable the plugin in your Tutor environment:
3232
3333 tutor plugins enable notifications
3434
35- When enabled, the plugin automatically :
35+ When enabled, the plugin requires two additional steps to fully set up notifications :
3636
37- - Enables the following waffle flags:
37+ 1. ** Initialize notifications plugin **
3838
39- - ``notifications.enable_notifications ``
40- - ``notifications.enable_email_notifications ``
39+ Run the following command:
4140
42- - Sets the required environment variables for the notifications service
41+ .. code-block :: bash
4342
44- - `` SHOW_EMAIL_CHANNEL `` (defaults to TRUE)
45- - `` SHOW_PUSH_CHANNEL `` (defaults to FALSE)
43+ tutor [local/dev/k8s] do init --limit=notifications
44+
4645
47- .. important : :
46+ This configures the required waffle flags and environment variables :
4847
49- After enabling the notifications plugin, site operators **must rebuild the
50- MFE image ** for the notification tray to appear in the user interface.
48+ - Waffle flags:
49+ - ``notifications.enable_notifications ``
50+ - ``notifications.enable_email_notifications ``
51+ - Environment variables:
52+ - ``SHOW_EMAIL_CHANNEL `` (defaults to TRUE)
53+ - ``SHOW_PUSH_CHANNEL `` (defaults to FALSE)
5154
52- Rebuild the MFE image:
55+ 2. ** Rebuild the MFE image **
5356
54- .. code-block :: bash
57+ After initialization, rebuild the MFE image so the notification tray appears:
58+
59+ .. code-block :: bash
5560
56- tutor images build mfe
61+ tutor images build mfe
5762
5863
5964 Configure the notifications plugin
0 commit comments