diff --git a/requirements/base.in b/requirements/base.in index 65c003089..67a4524f8 100644 --- a/requirements/base.in +++ b/requirements/base.in @@ -15,3 +15,4 @@ sphinx-tags sphinx-notfound-page sphinxemoji myst_parser +linuxdoc diff --git a/requirements/base.txt b/requirements/base.txt index 35514cd43..43993ed99 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -28,9 +28,12 @@ colorama==0.4.6 # via sphinx-autobuild docutils==0.21.2 # via + # linuxdoc # myst-parser # pydata-sphinx-theme # sphinx +fspath==20230629 + # via linuxdoc h11==0.16.0 # via uvicorn idna==3.11 @@ -43,6 +46,8 @@ jinja2==3.1.6 # via # myst-parser # sphinx +linuxdoc==20240924 + # via -r requirements/base.in markdown-it-py==3.0.0 # via # mdit-py-plugins @@ -77,6 +82,8 @@ requests==2.32.5 # sphinxcontrib-youtube roman-numerals-py==3.1.0 # via sphinx +six==1.17.0 + # via fspath snowballstemmer==3.0.1 # via sphinx soupsieve==2.8 @@ -84,6 +91,7 @@ soupsieve==2.8 sphinx==8.2.3 # via # -r requirements/base.in + # linuxdoc # myst-parser # pydata-sphinx-theme # sphinx-autobuild @@ -130,7 +138,7 @@ sphinxcontrib-serializinghtml==2.0.0 # via sphinx sphinxcontrib-youtube==1.4.1 # via -r requirements/base.in -sphinxemoji==0.3.1 +sphinxemoji==0.3.2 # via -r requirements/base.in sphinxext-rediraffe==0.3.0 # via -r requirements/base.in @@ -150,3 +158,6 @@ watchfiles==1.1.1 # via sphinx-autobuild websockets==15.0.1 # via sphinx-autobuild + +# The following packages are considered to be unsafe in a requirements file: +# setuptools diff --git a/source/_images/release_notes/ulmo/ulmo_notifications_email.png b/source/_images/release_notes/ulmo/ulmo_notifications_email.png new file mode 100644 index 000000000..cc5514fbf Binary files /dev/null and b/source/_images/release_notes/ulmo/ulmo_notifications_email.png differ diff --git a/source/_images/release_notes/ulmo/ulmo_notifications_preferences.png b/source/_images/release_notes/ulmo/ulmo_notifications_preferences.png new file mode 100644 index 000000000..a8aec60c6 Binary files /dev/null and b/source/_images/release_notes/ulmo/ulmo_notifications_preferences.png differ diff --git a/source/_images/release_notes/ulmo/ulmo_tray.png b/source/_images/release_notes/ulmo/ulmo_tray.png new file mode 100644 index 000000000..1d00b731d Binary files /dev/null and b/source/_images/release_notes/ulmo/ulmo_tray.png differ diff --git a/source/community/release_notes/ulmo/dev_op_release_notes.rst b/source/community/release_notes/ulmo/dev_op_release_notes.rst index d956dcbd5..fd60c3084 100644 --- a/source/community/release_notes/ulmo/dev_op_release_notes.rst +++ b/source/community/release_notes/ulmo/dev_op_release_notes.rst @@ -129,6 +129,7 @@ Then run this to update materialized views that have new/removed columns:: tutor local do dbt --only_changed False -c 'run --full-refresh --select dim_learner_last_response dim_problem_results problem_events dim_subsection_problem_results' +.. _Ulmo operators: Administrators & Operators ************************** diff --git a/source/community/release_notes/ulmo/feature_release_notes.rst b/source/community/release_notes/ulmo/feature_release_notes.rst index cd956fed7..1f298db56 100644 --- a/source/community/release_notes/ulmo/feature_release_notes.rst +++ b/source/community/release_notes/ulmo/feature_release_notes.rst @@ -12,6 +12,7 @@ Open edX Ulmo Release - Product Release Notes ulmo_libraries ulmo_rp + ulmo_notifications ulmo_mobile_updates ulmo_catalog ulmo_reusable_lti diff --git a/source/community/release_notes/ulmo/ulmo_marketing_notes.rst b/source/community/release_notes/ulmo/ulmo_marketing_notes.rst index b4c5db648..75ecdea01 100644 --- a/source/community/release_notes/ulmo/ulmo_marketing_notes.rst +++ b/source/community/release_notes/ulmo/ulmo_marketing_notes.rst @@ -28,7 +28,7 @@ has achieved the `LTI Advantage Complete major glow-up! New, customizable pages help you showcase courses with modern design and full theming support. -**Smart Notifications**: Never let students miss important discussions again! +:ref:`Smart Notifications `: Never let students miss important discussions again! Keep learners engaged with timely alerts about new posts and announcements, delivered both in-platform and via email. diff --git a/source/community/release_notes/ulmo/ulmo_notifications.rst b/source/community/release_notes/ulmo/ulmo_notifications.rst new file mode 100644 index 000000000..b05ef63ad --- /dev/null +++ b/source/community/release_notes/ulmo/ulmo_notifications.rst @@ -0,0 +1,161 @@ +.. _Ulmo Notifications: + +Introducing Activity Notifications +################################### + +The Ulmo release introduces a new Notifications experience that helps learners +and instructors stay informed about course activity. This is the first release +where the feature is available and more upgrades are underway. + +Notification Tray +***************** + +A bell icon (🔔) in the upper right corner of all pages shows unread +notifications count across discussions, grading, and course updates. Clicking on +the icon opens the tray which displays notifications organized by platform area. + +.. figure:: /_images/release_notes/ulmo/ulmo_tray.png + :alt: The notifications tray appears to the right of course content + + Web interface showing the notification bell icon with an unread count, and the notification tray expanded + +Email Notifications +******************* + +Users can receive notifications by email, with flexible delivery options: +immediately, daily, or weekly. + +Daily and weekly emails contain notifications from the past 24 hours and 7 days, +respectively. Site operators can configure schedule of these emails. + +.. figure:: /_images/release_notes/ulmo/ulmo_notifications_email.png + :alt: A screenshot of a daily email, showing 1 course update, 1 grade update, and 9 new discussion comments/threads + + Daily email digest displaying notifications from Discussions, Grading, and Course Updates. + +Notification Preferences +************************ + +:ref:`Notification preferences ` on the user +Account Settings page allows users to choose which activities they want to hear +about, how often, and through which channels (in-platform tray and/or email). + +.. figure:: /_images/release_notes/ulmo/ulmo_notifications_preferences.png + :alt: A screenshot of the Account Settings > Notifications page + + Notification preferences on the Account Settings page, showing toggles for enabling tray and email notifications and dropdown menus for selecting email frequency. + +Supported Activities +******************** + +The table below summarizes all supported activities and their corresponding preferences. + +.. flat-table:: Table listing supported notification types, including activity and preference name, audience and defaults. + :header-rows: 1 + + * - # + - Activity + - Recipients + - Preference Name + - Tray Default + - Email Default + * - 1 + - New response on your post + - Post author + - :rspan:`6` Activity Notifications + - :rspan:`6` ON + - :rspan:`6` Daily + * - 2 + - New comment on your post + - Post author + * - 3 + - New comment on your response + - Response author + * - 4 + - New response on a post you follow + - Post follower + * - 5 + - New comment on a post you follow + - Post follower + * - 6 + - Response on your post is endorsed + - Post author + * - 7 + - Your response is endorsed + - Response author + * - 8 + - A new discussion-type post + - Anyone + - New discussion posts + - OFF + - OFF + * - 9 + - A new question-type post + - Anyone + - New question posts + - OFF + - OFF + * - 10 + - A new post from the course instructor + - Anyone + - New posts from instructors + - ON + - Daily + * - 11 + - A post has been reported + - :rspan:`2` Forum moderators + - :rspan:`2` Reported content + - :rspan:`2` ON + - :rspan:`2` Daily + * - 12 + - A response has been reported + * - 13 + - A comment has been reported + * - 14 + - New course updates + - All enrollees in a course + - Course updates + - ON + - Daily + * - 15 + - New ORA submission for staff review + - Staff, Admin on a course + - New ORA submission for staff + - ON + - OFF + * - 16 + - ORA grade awarded to learner + - Learners + - ORA grade received + - ON + - Daily + + + + +Documentation +************* + +For instructions on using Notifications in courses, managing preferences, +reviewing activity, and understanding delivery settings, please refer to the +:ref:`Notifications & Preferences`. + +For site operators, configuration options are available in the :ref:`Operator release notes `. + + + +.. seealso:: + + :ref:`Notifications & Preferences` + + :ref:`Discussions Notifications ` + + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 2025-12-05 | Product WG | Ulmo | Pass | ++--------------+-------------------------------+----------------+--------------------------------+ \ No newline at end of file diff --git a/source/conf.py b/source/conf.py index b3e351b44..caa53ca16 100644 --- a/source/conf.py +++ b/source/conf.py @@ -52,6 +52,7 @@ "sphinx_tags", "sphinxemoji.sphinxemoji", "myst_parser", + "linuxdoc.rstFlatTable", ] # Extension Configuration