-
Notifications
You must be signed in to change notification settings - Fork 333
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2176 from openedx/sundasNew/INF-1017
docs: added notification doc for course author and open edx student
- Loading branch information
Showing
11 changed files
with
177 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
en_us/course_authors/source/managing_notifications/index.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.. _Managing Notification Index: | ||
|
||
Managing Notifications | ||
###################### | ||
|
||
Use the topics in this section to learn about managing notifications. | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
managing_notifications |
1 change: 1 addition & 0 deletions
1
en_us/course_authors/source/managing_notifications/managing_notifications.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../../../shared/managing_notifications/managing_notifications.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
en_us/open_edx_students/source/sfd_notifications/index.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.. _SFD Notification Index: | ||
|
||
Managing Notifications | ||
###################### | ||
|
||
Use the topics in this section to learn about managing notifications. | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
managing_notifications |
1 change: 1 addition & 0 deletions
1
en_us/open_edx_students/source/sfd_notifications/managing_notifications.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../../../shared/managing_notifications/managing_notifications.rst |
151 changes: 151 additions & 0 deletions
151
en_us/shared/managing_notifications/managing_notifications.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
.. _Managing Notifications: | ||
|
||
Navigating the Notifications Tray & Preferences | ||
############################################### | ||
|
||
This topic describes how to navigate the notifications tray & preferences. | ||
|
||
.. contents:: | ||
:local: | ||
:depth: 2 | ||
|
||
.. _Accessing Notifications Tray: | ||
|
||
Accessing the Notifications Tray | ||
******************************** | ||
|
||
At the top right of your screen, there's a bell icon. When there are | ||
unseen notifications, a count will appear next to this icon. Clicking | ||
the bell reveals the notifications tray, and this count resets to zero. | ||
To exit, simply click anywhere outside the tray. Inside, notifications | ||
are sorted into tabs by platform areas. For example, the "Discussion" | ||
tab contains forum-related notifications. Clicking on a notification | ||
opens related content in a new tab. | ||
|
||
.. image:: ../../../shared/students/Images/SFD_Unseen_Notifications_Count.png | ||
:width: 300 | ||
:align: center | ||
:alt: Notification bell icon and notification count badge on it When there | ||
are unseen notifications. | ||
|
||
.. _Notification Icons, Alerts & Context: | ||
|
||
Notification Icons, Alerts & Context | ||
************************************ | ||
|
||
Each unread notification has a red dot on the right side. There's an icon on | ||
the left that shows the type of notification, so you can quickly understand | ||
its nature without reading the whole alert. The notification also shows the | ||
course's name to tell you where the update is coming from. For instance, if | ||
it's news from a forum, you'll know which course's forum it's about. | ||
|
||
.. image:: ../../../shared/students/Images/SFD_Detailed_Notifications_Tray.png | ||
:width: 400 | ||
:height: 500 | ||
:align: center | ||
:alt: Notification tray has red dot on the right side for each unread notification, | ||
notification type icon, and course name. | ||
|
||
.. _Interacting with Notifications: | ||
|
||
Interacting with Notifications | ||
****************************** | ||
|
||
Once you open the notifications tray, the unseen count will be reset. Inside, | ||
notifications are organized into tabs corresponding to their learning activity. | ||
For instance, the "Discussions" tab houses all forum notifications. Clicking on | ||
a notification directs you to its context, like a discussion thread for forum | ||
alerts. If you want to see more, a "Load More" button fetches the next 10 | ||
notifications. To mark everything as seen, there's a "Mark All as Read" button. | ||
Additionally, the top right of the tray features a gear icon, leading you to the | ||
preferences page where you can adjust your notification settings. | ||
|
||
.. _Notification Lifecycle: | ||
|
||
Notification Lifecycle | ||
********************** | ||
|
||
In the spirit of keeping your notification tray decluttered and ensuring relevance, | ||
the system is designed such that any notification older than three months will be | ||
automatically deleted. This guarantees that your tray is always populated with recent | ||
and pertinent alerts. | ||
|
||
Personalizing Your Notification Preferences | ||
******************************************* | ||
|
||
.. contents:: | ||
:local: | ||
:depth: 1 | ||
|
||
.. _Accessing Notification Preference Settings: | ||
|
||
Accessing Notification Preference Settings | ||
========================================== | ||
|
||
You have two ways to get to your notification preference settings: | ||
|
||
#. Click on the gear icon at the top of the Notifications Tray. | ||
|
||
#. In "Account Settings", there's a link on the left that says "Notification preferences". | ||
|
||
.. _Course Specific Preferences: | ||
|
||
Course-Specific Preferences | ||
=========================== | ||
|
||
Your notification preference settings are set up by course. So, if you're in | ||
multiple courses, you'll see a list of them when you open the preferences. | ||
Just click on a course to adjust the notifications for it. | ||
|
||
.. image:: ../../../shared/students/Images/SFD_Course_Specific_Preferences.png | ||
:width: 700 | ||
:align: center | ||
:alt: View list of courses if you're enrolled in multiple courses. | ||
|
||
.. _Choosing Notifications for Platform Areas: | ||
|
||
Choosing Notifications for Platform Areas | ||
========================================= | ||
|
||
Inside each course's settings, you can pick the platform areas you want to get | ||
notifications from. For example, if you don't want any alerts from 'Discussions', | ||
you can turn it OFF. If you dive deeper into these areas, you can also choose | ||
specific activities you want to be notified about. | ||
|
||
.. _Discussion Notifications: | ||
|
||
Discussion Notifications | ||
======================== | ||
|
||
For the "Discussions" area, here are the choices: | ||
|
||
#. Core notifications: This is ON by default for everyone and cannot be turned OFF. | ||
However, the toggle for ‘Discussions’ overrides this preference. When turned ON, | ||
you’ll get notifications for: | ||
|
||
a. New responses or comments on your posts. | ||
|
||
b. New comments on your responses. | ||
|
||
c. New responses or comments on posts you're following. | ||
|
||
d. When a moderator endorses your response. | ||
|
||
e. When a moderator endorses a response on your post. | ||
|
||
#. New discussion posts: This is OFF to start with. Turn it on if you want to be | ||
notified about new discussion-type posts. | ||
|
||
#. New question posts: This is also OFF to start with. Turn it on if you want to | ||
be notified about new question-type posts. | ||
|
||
#. Reported content: Only for discussion moderators. It's ON from the start. If | ||
you are a forum moderator, you'll be notified when someone reports a post, response, | ||
or comment. | ||
|
||
.. image:: ../../../shared/students/Images/SFD_Forum_Notifications.png | ||
:width: 500 | ||
:align: center | ||
:alt: Enable/disable web nofitications for core notifications, new discussion posts, | ||
new question posts, and reported content. | ||
|
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.