docs: Update enable_notifications.rst with initialization details#1452
docs: Update enable_notifications.rst with initialization details#1452Vishwajit-Herma wants to merge 3 commits intoopenedx:mainfrom
Conversation
Clarified the initialization step required after enabling the notifications plugin, including the necessary command and environment variables.
|
Thanks for the pull request, @Vishwajit-Herma! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Clarify the requirement to perform the initialization task before rebuilding the MFE image.
Clarified the wording regarding the initialization step for enabling notifications.
|
@saraburns1 could you take a look at this? |
musaabhasan
left a comment
There was a problem hiding this comment.
I reviewed the notification setup change from an operator-runbook perspective. The intent is useful, but the command syntax and rebuild note should be tightened so site operators can copy the steps without ambiguity.
| .. code-block:: bash | ||
|
|
||
| - Sets the required environment variables for the notifications service | ||
| tutor dev [do/local/k8s] init --limit notifications |
There was a problem hiding this comment.
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) | ||
|
|
||
| .. important:: |
There was a problem hiding this comment.
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.
Clarified the initialization step required after enabling the notifications plugin, including the necessary command and environment variables.