Skip to content

Commit 7ef74f0

Browse files
committed
IBX-9060: Describe notifications in user doc (#368)
* Describe notifications in user doc * Add "New in doc" label
1 parent bd72baa commit 7ef74f0

10 files changed

+91
-1
lines changed

docs/getting_started/discover_ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ D\. Drop-down that changes the site context
2222

2323
![Top bar with site context selector](img/top_bar.png "Top bar with site context selector")
2424

25-
E\. Notification icon that informs you about incoming assignments, for example, items assigned for [your review](../content_management/workflow_management/editorial_workflow.md#review-queue)
25+
E\. [Notification](notifications.md) icon that informs you about incoming assignments or requests, for example, when another user invites you to preview their work or when items are assigned for [your review](../content_management/workflow_management/editorial_workflow.md#review-queue)
2626

2727
F\. App switcher which includes links to official websites of the QNTM group ecosystem companies, world-class ad-tech and mar-tech solution providers
2828

3.14 KB
Loading
9.52 KB
Loading
3.97 KB
Loading
20.3 KB
Loading
54.7 KB
Loading
63.9 KB
Loading
13.1 KB
Loading
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
description: Get to know about notifications.
3+
month_change: true
4+
---
5+
6+
# Notifications
7+
8+
With real-time notifications you stay informed and can take appropriate actions immediately.
9+
10+
Notifications inform you about incoming assignments or requests, for example, when:
11+
12+
- another user invites you to preview their work
13+
- when items are assigned for [your review](../content_management/workflow_management/editorial_workflow.md#review-queue)
14+
- when another user requests that you [release a lock](work_with_versions.md#release-locked-drafts)
15+
- when items are [sent to trash](copy_move_hide_content.md#remove-content)
16+
17+
## Access notifications
18+
19+
At the top of the main screen you can see a top bar.
20+
The top bar contains a notification icon.
21+
When you receive a new notification, a badge appears on the notification icon, with a number of notifications that require your attention, and a message appears on the screen to notify you of new notifications.
22+
23+
![New notification message](new_notification_message.png "New notification message")
24+
25+
If you have already received notifications and didn't act on then, a number of notifications on the badge increases when you receive another one.
26+
27+
![Notification icon on the top bar](img/top_bar_with_notification_icon.png "Notification icon on the top bar")
28+
29+
Click the notification icon to view a short list with the most recent notifications, arranged from newest to oldest.
30+
Here, you can click certain notifications in the short list to act on them, according to their originator's request.
31+
32+
You can click the three dots icon on the right side of each individual notification and mark it as read or delete it.
33+
You can also click **Mark all as read** to mark all notifications as read.
34+
35+
![Short list of notifications](notifications_short_list.png "Short list of notifications")
36+
37+
!!! note "Informative notifications"
38+
39+
Some notifications are informative only, and do not require your action.
40+
An example could be an information that scheduled publication of a content item has been cancelled.
41+
42+
## View all notifications in Notifications screen
43+
44+
The short list holds a limited number of notifications.
45+
You can see all the notifications that you have received in the **Notifications** screen.
46+
47+
1. In the top bar, click a notification icon. Then, at the bottom of the short list, click **View all notifications...**.
48+
49+
Here, you can see a list of notifications, together with information about their status and arrival date and time.
50+
51+
![Notifications screen](img/notifications_screen.png "Notifications screen")
52+
53+
!!! note "List pagination"
54+
55+
The list can take more than one screen. If it is so, you can click the arrows and numbers at the bottom of the screen to navigate the list.
56+
57+
2. Narrow down the list of displayed notifications by selecting one or more of the following filters:
58+
59+
- **Notification type**: for example, content item review request
60+
- **Status**: unread or read
61+
- **Date and time**: start and end of date range within which the notification was received
62+
63+
![Notification filters](img/notifications_filters.png "Notification filters")
64+
65+
3. Click **Apply** to confirm your choices.
66+
67+
4. To clear all the filters, click **Clear filters**.
68+
69+
### Act on notifications
70+
71+
In the notification screen, you can act on the notification to fulfill the request of the originator.
72+
73+
To act on a notification, find it in the notifications list and click an icon next to the notification's date and time.
74+
Depending on the context, the icon can be called differently, for example, **Go to content** or **Accept request**.
75+
76+
### Delete notifications or change their status
77+
78+
You may want to change the status of multiple or individual notifications in the **Notifications** screen, or even delete them completely.
79+
80+
1. Use filters to find the notifications that you want to delete or change their status.
81+
82+
2. To toggle the status of an individual notification, find it in the notifications list and, in its line, next to the notifications date and time, click an envelope icon.
83+
84+
3. To delete multiple notifications at once or mark them as read, in the **Notifications** screen:
85+
86+
- select checkboxes next to notifications that you want to process
87+
- at the top of the list, click **Mark as read** or **Delete**.
88+
89+
![Bulk action buttons](img/notifications_bulk_action_buttons.png "Bulk action buttons")

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ nav:
2222
- Work with dashboard: getting_started/dashboard/work_with_dashboard.md
2323
- Dashboard block reference: getting_started/dashboard/dashboard_block_reference.md
2424
- Content tree: getting_started/content_tree/content_tree.md
25+
- Notifications: getting_started/notifications.md
2526
- Content model management:
2627
- Content model: content_management/content_model.md
2728
- Create and edit content types: content_management/create_edit_content_types.md

0 commit comments

Comments
 (0)