diff --git a/en/docs/assets/img/learn/notifications/notification-icon-publisher-portal.png b/en/docs/assets/img/learn/notifications/notification-icon-publisher-portal.png new file mode 100644 index 0000000000..e7d350e08d Binary files /dev/null and b/en/docs/assets/img/learn/notifications/notification-icon-publisher-portal.png differ diff --git a/en/docs/assets/img/learn/notifications/notification-page-publisher-portal.png b/en/docs/assets/img/learn/notifications/notification-page-publisher-portal.png new file mode 100644 index 0000000000..9fd95bd872 Binary files /dev/null and b/en/docs/assets/img/learn/notifications/notification-page-publisher-portal.png differ diff --git a/en/docs/assets/img/learn/notifications/notifications-delete-all.png b/en/docs/assets/img/learn/notifications/notifications-delete-all.png new file mode 100644 index 0000000000..82831ee3f0 Binary files /dev/null and b/en/docs/assets/img/learn/notifications/notifications-delete-all.png differ diff --git a/en/docs/assets/img/learn/notifications/notifications-delete.png b/en/docs/assets/img/learn/notifications/notifications-delete.png new file mode 100644 index 0000000000..e9e281b518 Binary files /dev/null and b/en/docs/assets/img/learn/notifications/notifications-delete.png differ diff --git a/en/docs/assets/img/learn/notifications/notifications-mark-all-as-read.png b/en/docs/assets/img/learn/notifications/notifications-mark-all-as-read.png new file mode 100644 index 0000000000..958d726e89 Binary files /dev/null and b/en/docs/assets/img/learn/notifications/notifications-mark-all-as-read.png differ diff --git a/en/docs/assets/img/learn/notifications/notifications-mark-as-read.png b/en/docs/assets/img/learn/notifications/notifications-mark-as-read.png new file mode 100644 index 0000000000..5e673cd7d1 Binary files /dev/null and b/en/docs/assets/img/learn/notifications/notifications-mark-as-read.png differ diff --git a/en/docs/assets/img/learn/notifications/notifications-page-developer-portal.png b/en/docs/assets/img/learn/notifications/notifications-page-developer-portal.png new file mode 100644 index 0000000000..de2018d7d9 Binary files /dev/null and b/en/docs/assets/img/learn/notifications/notifications-page-developer-portal.png differ diff --git a/en/docs/assets/img/learn/notifications/notifications-sort.png b/en/docs/assets/img/learn/notifications/notifications-sort.png new file mode 100644 index 0000000000..327f214033 Binary files /dev/null and b/en/docs/assets/img/learn/notifications/notifications-sort.png differ diff --git a/en/docs/design/advanced-topics/notifications/notifications-overview.md b/en/docs/design/advanced-topics/notifications/notifications-overview.md new file mode 100644 index 0000000000..e8d0a40b5a --- /dev/null +++ b/en/docs/design/advanced-topics/notifications/notifications-overview.md @@ -0,0 +1,98 @@ +# Notifications + +The Notification System for WSO2 API Manager addresses a critical deficiency within the platform by introducing a mechanism to inform API Publishers and Developers about crucial changes to their APIs or subscriptions. This system aims to enhance communication, transparency, and responsiveness within the API management processes by providing timely alerts and updates regarding significant events such as workflow rejections, subscription blockings, and API-related updates. + + + +## Notifications in the Publisher Portal: + +When a publisher user has new notifications, the bell icon on the header will display the number of unread notifications. These notifications include events such as workflow approvals or rejections and API-related updates. + +
+ +[![Notification Icon](../../../assets/img/learn/notifications/notification-icon-publisher-portal.png)](../../../assets/img/learn/notifications/notification-icon-publisher-portal.png) + +
+ +Clicking the bell icon will navigate you to the notification page, where you can manage your notifications. + +
+ +[![Notification Page](../../../assets/img/learn/notifications/notification-page-publisher-portal.png)](../../../assets/img/learn/notifications/notification-page-publisher-portal.png) + +
+ +### Manage Notifications + +1. **Mark Notifications as Read:** + + After reading a notification, you can click on the "Mark as Read" icon associated with each notification. This action visually grayed out the notification, indicating that it has been read. The unread count displayed with the bell icon will update automatically. + +
+ + [![Mark as Read a Notification](../../../assets/img/learn/notifications/notifications-mark-as-read.png)](../../../assets/img/learn/notifications/notifications-mark-as-read.png) + +
+ + To mark all notifications as read with one click, use the "Mark all as Read" button displayed on the top bar of the notification page. + +
+ + [![Mark as Read all the Notifications](../../../assets/img/learn/notifications/notifications-mark-all-as-read.png)](../../../assets/img/learn/notifications/notifications-mark-all-as-read.png) + +
+ +2. **Delete Notifications:** + + If you want to delete a specific notification, click on the delete icon next to it. A delete confirmation dialog will appear, and upon confirmation, the notification will be deleted. + +
+ + [![Delete a Notification](../../../assets/img/learn/notifications/notifications-delete.png)](../../../assets/img/learn/notifications/notifications-delete.png) + +
+ + Similarly, you can delete all notifications at once by clicking the "Delete All" button on the top of the notification page. + +
+ + [![Delete all Notifications](../../../assets/img/learn/notifications/notifications-delete-all.png)](../../../assets/img/learn/notifications/notifications-delete-all.png) + +
+ +3. **Sort Notifications:** + + By default, the notifications are shown in the order of latest first. However, if you prefer to view older notifications first, you can change the sort option to 'oldest'. + +
+ + [![Sort Notifications](../../../assets/img/learn/notifications/notifications-sort.png)](../../../assets/img/learn/notifications/notifications-sort.png) + +
+ + +## Notifications in the Developer Portal: + +The notification management process for developers is identical to that of publishers. Therefore, developers can follow the same instructions provided for [Notifications in the Publisher Portal](#NotificationsInThePublisherPortal). + +
+ +[![Developer side notification page](../../../assets/img/learn/notifications/notifications-page-developer-portal.png)](../../../assets/img/learn/notifications/notifications-page-developer-portal.png) + +
+ +### Conclusion: + +The Notification System for WSO2 API Manager is a crucial feature that enhances communication, transparency, and responsiveness within the API management processes. By providing timely alerts and updates, stakeholders can effectively manage their APIs and subscriptions, leading to improved efficiency and productivity. Regularly checking and responding to notifications is important to stay informed and to ensure smooth API management operations. + + + + + + + + + + + + diff --git a/en/mkdocs.yml b/en/mkdocs.yml index c0f3f8d2e6..aff25b65c4 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -227,6 +227,8 @@ nav: - Add an API State Change Workflow: design/advanced-topics/adding-an-api-state-change-workflow.md - Block Subscription to an API: design/advanced-topics/block-subscription-to-an-api.md - Validate API Definitions with Linters: design/advanced-topics/validate-api-definitions-with-linters.md + - Notifications: + - Overview: design/advanced-topics/notifications/notifications-overview.md - Deploy and Publish APIs: - Deploy on Gateway: - Deploy API: