diff --git a/docs/getting_started/discover_ui.md b/docs/getting_started/discover_ui.md index 45122d12..efb678b4 100644 --- a/docs/getting_started/discover_ui.md +++ b/docs/getting_started/discover_ui.md @@ -22,7 +22,7 @@ D\. Drop-down that changes the site context ![Top bar with site context selector](img/top_bar.png "Top bar with site context selector") -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) +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) F\. App switcher which includes links to official websites of the QNTM group ecosystem companies, world-class ad-tech and mar-tech solution providers diff --git a/docs/getting_started/img/bulk_action_buttons.png b/docs/getting_started/img/bulk_action_buttons.png new file mode 100644 index 00000000..a7d12de3 Binary files /dev/null and b/docs/getting_started/img/bulk_action_buttons.png differ diff --git a/docs/getting_started/img/new_notification_message.png b/docs/getting_started/img/new_notification_message.png new file mode 100644 index 00000000..ba620b1d Binary files /dev/null and b/docs/getting_started/img/new_notification_message.png differ diff --git a/docs/getting_started/img/notifications_bulk_action_buttons.png b/docs/getting_started/img/notifications_bulk_action_buttons.png new file mode 100644 index 00000000..f1646600 Binary files /dev/null and b/docs/getting_started/img/notifications_bulk_action_buttons.png differ diff --git a/docs/getting_started/img/notifications_filters.png b/docs/getting_started/img/notifications_filters.png new file mode 100644 index 00000000..0f1094a5 Binary files /dev/null and b/docs/getting_started/img/notifications_filters.png differ diff --git a/docs/getting_started/img/notifications_screen.png b/docs/getting_started/img/notifications_screen.png new file mode 100644 index 00000000..1b06d5f9 Binary files /dev/null and b/docs/getting_started/img/notifications_screen.png differ diff --git a/docs/getting_started/img/notifications_short_list.png b/docs/getting_started/img/notifications_short_list.png new file mode 100644 index 00000000..a409e405 Binary files /dev/null and b/docs/getting_started/img/notifications_short_list.png differ diff --git a/docs/getting_started/img/top_bar_with_notification_icon.png b/docs/getting_started/img/top_bar_with_notification_icon.png new file mode 100644 index 00000000..9ef29b53 Binary files /dev/null and b/docs/getting_started/img/top_bar_with_notification_icon.png differ diff --git a/docs/getting_started/notifications.md b/docs/getting_started/notifications.md new file mode 100644 index 00000000..ecdc636c --- /dev/null +++ b/docs/getting_started/notifications.md @@ -0,0 +1,89 @@ +--- +description: Get to know about notifications. +month_change: true +--- + +# Notifications + +With real-time notifications you stay informed and can take appropriate actions immediately. + +Notifications inform you about incoming assignments or requests, for example, when: + +- another user invites you to preview their work +- when items are assigned for [your review](../content_management/workflow_management/editorial_workflow.md#review-queue) +- when another user requests that you [release a lock](work_with_versions.md#release-locked-drafts) +- when items are [sent to trash](copy_move_hide_content.md#remove-content) + +## Access notifications + +At the top of the main screen you can see a top bar. +The top bar contains a notification icon. +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. + +![New notification message](new_notification_message.png "New notification message") + +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. + +![Notification icon on the top bar](img/top_bar_with_notification_icon.png "Notification icon on the top bar") + +Click the notification icon to view a short list with the most recent notifications, arranged from newest to oldest. +Here, you can click certain notifications in the short list to act on them, according to their originator's request. + +You can click the three dots icon on the right side of each individual notification and mark it as read or delete it. +You can also click **Mark all as read** to mark all notifications as read. + +![Short list of notifications](notifications_short_list.png "Short list of notifications") + +!!! note "Informative notifications" + + Some notifications are informative only, and do not require your action. + An example could be an information that scheduled publication of a content item has been cancelled. + +## View all notifications in Notifications screen + +The short list holds a limited number of notifications. +You can see all the notifications that you have received in the **Notifications** screen. + +1. In the top bar, click a notification icon. Then, at the bottom of the short list, click **View all notifications...**. + + Here, you can see a list of notifications, together with information about their status and arrival date and time. + + ![Notifications screen](img/notifications_screen.png "Notifications screen") + + !!! note "List pagination" + + 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. + +2. Narrow down the list of displayed notifications by selecting one or more of the following filters: + + - **Notification type**: for example, content item review request + - **Status**: unread or read + - **Date and time**: start and end of date range within which the notification was received + + ![Notification filters](img/notifications_filters.png "Notification filters") + +3. Click **Apply** to confirm your choices. + +4. To clear all the filters, click **Clear filters**. + +### Act on notifications + +In the notification screen, you can act on the notification to fulfill the request of the originator. + +To act on a notification, find it in the notifications list and click an icon next to the notification's date and time. +Depending on the context, the icon can be called differently, for example, **Go to content** or **Accept request**. + +### Delete notifications or change their status + +You may want to change the status of multiple or individual notifications in the **Notifications** screen, or even delete them completely. + +1. Use filters to find the notifications that you want to delete or change their status. + +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. + +3. To delete multiple notifications at once or mark them as read, in the **Notifications** screen: + + - select checkboxes next to notifications that you want to process + - at the top of the list, click **Mark as read** or **Delete**. + +![Bulk action buttons](img/notifications_bulk_action_buttons.png "Bulk action buttons") diff --git a/mkdocs.yml b/mkdocs.yml index 1a069ad5..10216a4f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,6 +22,7 @@ nav: - Work with dashboard: getting_started/dashboard/work_with_dashboard.md - Dashboard block reference: getting_started/dashboard/dashboard_block_reference.md - Content tree: getting_started/content_tree/content_tree.md + - Notifications: getting_started/notifications.md - Content model management: - Content model: content_management/content_model.md - Create and edit content types: content_management/create_edit_content_types.md