Skip to content

Commit 724d892

Browse files
authored
docs: Add link to notifications documentation (#38485)
* docs: Add link to new notifications documentation and remove from this repo * docs: fix whitespace * docs: pylint Split long comment into two lines for readability.
1 parent 54363d2 commit 724d892

8 files changed

Lines changed: 6 additions & 371 deletions

File tree

openedx/core/djangoapps/notifications/base_notification.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class NotificationType(TypedDict):
2828
# When True, user preferences are taken from the notification app's configuration,
2929
# overriding the `web`, `email`, `push`, `email_cadence`, and `non_editable` attributes set here.
3030
use_app_defaults: bool
31-
# Template string for notification content (see ./docs/templates.md).
31+
# Template string for notification content.
3232
# Wrap in gettext_lazy (_) for translation support.
3333
content_template: str
3434
# A map of variable names that can be used in the template, along with their descriptions.
@@ -58,7 +58,8 @@ class NotificationType(TypedDict):
5858
info: NotRequired[str]
5959

6060

61-
# For help defining new notifications, see ./docs/creating_a_new_notification_guide.md
61+
# For help defining new notifications, see
62+
# https://docs.openedx.org/en/latest/site_ops/how-tos/enable_notifications.html#creating-a-new-notification
6263
_COURSE_NOTIFICATION_TYPES = {
6364
'new_comment_on_response': {
6465
'notification_app': 'discussion',
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
See `docs.openedx.org <https://docs.openedx.org/en/latest/site_ops/how-tos/enable_notifications.html>`_ for more information on notifications.

openedx/core/djangoapps/notifications/docs/creating_a_new_notification_guide.md

Lines changed: 0 additions & 132 deletions
This file was deleted.

openedx/core/djangoapps/notifications/docs/cron_job_removal.md

Lines changed: 0 additions & 134 deletions
This file was deleted.

openedx/core/djangoapps/notifications/docs/getting-started.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

openedx/core/djangoapps/notifications/docs/settings.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

openedx/core/djangoapps/notifications/docs/templates.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)