Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting_started/discover_ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Binary file added docs/getting_started/img/bulk_action_buttons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/getting_started/img/notifications_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
89 changes: 89 additions & 0 deletions docs/getting_started/notifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---

Check warning on line 1 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L1

[Ibexa.ReadingLevel] The grade level is 8.91. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 8.91. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
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.

Check warning on line 25 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L25

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 25, "column": 146}}}, "severity": "WARNING"}

![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...**.

Check failure on line 47 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L47

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 47, "column": 45}}}, "severity": "ERROR"}

Here, you can see a list of notifications, together with information about their status and arrival date and time.

Check warning on line 49 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L49

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 49, "column": 5}}}, "severity": "WARNING"}

![Notifications screen](img/notifications_screen.png "Notifications screen")

!!! note "List pagination"

Check warning on line 54 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L54

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 54, "column": 1}}}, "severity": "WARNING"}
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.

Check failure on line 65 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L65

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 65, "column": 43}}}, "severity": "ERROR"}

4. To clear all the filters, click **Clear filters**.

Check failure on line 67 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L67

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 67, "column": 53}}}, "severity": "ERROR"}

### 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.

Check failure on line 80 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L80

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 80, "column": 88}}}, "severity": "ERROR"}

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.

Check warning on line 82 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L82

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 82, "column": 4}}}, "severity": "WARNING"}

Check failure on line 82 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L82

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 82, "column": 171}}}, "severity": "ERROR"}

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**.

Check failure on line 87 in docs/getting_started/notifications.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/notifications.md#L87

[Ibexa.Lists] Do not put fullstops at the end of bullets
Raw output
{"message": "[Ibexa.Lists] Do not put fullstops at the end of bullets", "location": {"path": "docs/getting_started/notifications.md", "range": {"start": {"line": 87, "column": 67}}}, "severity": "ERROR"}

![Bulk action buttons](img/notifications_bulk_action_buttons.png "Bulk action buttons")
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading