Skip to content

Commit

Permalink
docs: notifications (#3361)
Browse files Browse the repository at this point in the history
  • Loading branch information
kwasniew committed Mar 24, 2023
1 parent d877a37 commit d4b4866
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
32 changes: 32 additions & 0 deletions 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
3 changes: 2 additions & 1 deletion website/sidebars.js
Expand Up @@ -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',
Expand All @@ -333,7 +335,6 @@ module.exports = {
'reference/technical-debt',
'reference/unleash-context',
'reference/change-requests',
'reference/maintenance-mode',
],
},
'generated/unleash-edge',
Expand Down
Binary file added website/static/img/notifications.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d4b4866

Please sign in to comment.