(Issue #3015) Push notifications docs were added

epam · Mar 16, 2023 · 4c5c521 · 4c5c521
1 parent d5968bd
commit 4c5c521
Show file tree

Hide file tree

Showing 18 changed files with 128 additions and 16 deletions.
diff --git a/docs/md/manual/12_Manage_Settings/12.9._Change_email_notification.md b/docs/md/manual/12_Manage_Settings/12.9._Change_email_notification.md
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_01.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_01.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_02.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_02.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_03.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_03.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_04.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_04.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_05.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_05.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_06.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_06.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_07.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_07.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_08.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_08.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_09.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_09.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_10.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_10.png
diff --git a/docs/md/manual/12_Manage_Settings/attachments/PushNotification_11.png b/docs/md/manual/12_Manage_Settings/attachments/PushNotification_11.png
diff --git a/docs/md/release_notes/v.0.17/attachments/RN017_PushNotifications_01.png b/docs/md/release_notes/v.0.17/attachments/RN017_PushNotifications_01.png
diff --git a/docs/md/release_notes/v.0.17/attachments/RN017_PushNotifications_02.png b/docs/md/release_notes/v.0.17/attachments/RN017_PushNotifications_02.png
diff --git a/docs/md/release_notes/v.0.17/attachments/RN017_PushNotifications_03.png b/docs/md/release_notes/v.0.17/attachments/RN017_PushNotifications_03.png
diff --git a/docs/md/release_notes/v.0.17/attachments/RN017_PushNotifications_04.png b/docs/md/release_notes/v.0.17/attachments/RN017_PushNotifications_04.png
diff --git a/docs/md/release_notes/v.0.17/v.0.17_-_Release_notes.md b/docs/md/release_notes/v.0.17/v.0.17_-_Release_notes.md
@@ -343,6 +343,29 @@ If the node type is specified in this preference, listed above notifications wil
 This preference allows a comma-separated list of the node types and wildcards, e.g.:  
     ![CP_v.0.17_ReleaseNotes](attachments/RN017_NotificationsEnhancements_07.png)
 
+### Push notifications
+
+Previously, Cloud Pipeline platform sent notifications to users via email only. For many cases it would be useful to show such notifications in the GUI as well. In the current version, such ability was implemented.
+
+Now, all email notifications, that are sending by the platform, are also duplicated as push notifications. This allows to view notifications right in the Cloud Pipeline GUI.  
+Push notifications do not require additional configuring - they are fully the same as corresponding email notifications, i.e. have the same header, content, recepients list, frequency and trigger of sending, etc.
+
+Once any system event is occurred and its trigger for sending email notification has fired, email will be sent to the configured recipients. Simultaneously, the push notification (with the same subject and body as in the email) will be "sent" to the same recipients, e.g.:  
+    ![CP_v.0.17_ReleaseNotes](attachments/RN017_PushNotifications_01.png)
+
+Click it to view the whole notification - it will be opened in a pop-up:  
+    ![CP_v.0.17_ReleaseNotes](attachments/RN017_PushNotifications_02.png)
+
+Additionally, a new section appeared in the main menu - **Notifications**.  
+It allows to view all push notifications/emails sent to the current user, e.g.:  
+    ![CP_v.0.17_ReleaseNotes](attachments/RN017_PushNotifications_03.png)
+
+User can switch notifications lists - to display only new "unread" notifications or only "read" ones.  
+To view the notification full details, user can click it - notification will be opened in a pop-up:  
+    ![CP_v.0.17_ReleaseNotes](attachments/RN017_PushNotifications_04.png)
+
+For more details see [here](../../manual/12_Manage_Settings/12.9._Change_email_notification.md#push-notifications).
+
 ## Allowed price types for a cluster master node
 
 Previously, **Cloud Pipeline** allowed the user to choose whether the cluster master node be a `spot` or `on-demand` instance.  

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -90,7 +90,7 @@ nav:
     - 12.6. Edit a group/role: 'manual/12_Manage_Settings/12.6._Edit_a_group_role.md'
     - 12.7. Delete a group: 'manual/12_Manage_Settings/12.7._Delete_a_group.md'
     - 12.8. Change a set of roles/groups for a user: 'manual/12_Manage_Settings/12.8._Change_a_set_of_roles_groups_for_a_user.md'
-    - 12.9. Change email notification: 'manual/12_Manage_Settings/12.9._Change_email_notification.md'
+    - 12.9. Email notifications: 'manual/12_Manage_Settings/12.9._Change_email_notification.md'
     - 12.10. Manage system-level settings: 'manual/12_Manage_Settings/12.10._Manage_system-level_settings.md'
     - 12.11. Advanced features: 'manual/12_Manage_Settings/12.11._Advanced_features.md'
     - 12.12. System logs: 'manual/12_Manage_Settings/12.12._System_logs.md'