diff --git a/website/docs/reference/notifications.md b/website/docs/reference/notifications.md new file mode 100644 index 0000000000..fa989eb147 --- /dev/null +++ b/website/docs/reference/notifications.md @@ -0,0 +1,32 @@ +--- +title: Notifications +--- + +:::info Availability + +Notifications were introduced in Unleash 4.22.0 for pro and enteprise customers. + +::: + +Unleash's notifications give you updates when certain events occur in projects that you are part of. The notifications are accessible from the notifications button in the navigation section of the admin UI. + +Your notifications will only contain updates from other members; you will not get notifications about actions you perform yourself. + +![The notifications overview. It's telling the user about a feature that was enabled in production and that there is a change request ready for review.](/img/notifications.png) + +From within the notifications list, you can: +* navigate to the features or change request that the notification is for +* mark all notifications as read +* filter out unread notifications + +Notifications can not be disabled. + +## Notification events + +The following actions in your projects will trigger notifications: +* Creating a feature +* Archiving a feature +* Enabling a feature in an environment +* Submitting a change request (sent only to project members who can approve the change request) +* Approving change request +* Applying change request diff --git a/website/sidebars.js b/website/sidebars.js index d11e6e5a2b..42b5f54756 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -318,7 +318,9 @@ module.exports = { 'reference/feature-toggle-variants', 'reference/front-end-api', 'reference/login-history', + 'reference/maintenance-mode', 'reference/network-view', + 'reference/notifications', 'reference/playground', 'reference/public-signup', 'reference/projects', @@ -333,7 +335,6 @@ module.exports = { 'reference/technical-debt', 'reference/unleash-context', 'reference/change-requests', - 'reference/maintenance-mode', ], }, 'generated/unleash-edge', diff --git a/website/static/img/notifications.png b/website/static/img/notifications.png new file mode 100644 index 0000000000..a42cacc5d6 Binary files /dev/null and b/website/static/img/notifications.png differ