diff --git a/docs/assets/images/part/notification_flyout.png b/docs/assets/images/part/notification_flyout.png new file mode 100644 index 0000000..9a12441 Binary files /dev/null and b/docs/assets/images/part/notification_flyout.png differ diff --git a/docs/assets/images/part/notification_header.png b/docs/assets/images/part/notification_header.png new file mode 100644 index 0000000..b089eb7 Binary files /dev/null and b/docs/assets/images/part/notification_header.png differ diff --git a/docs/assets/images/part/notification_history.png b/docs/assets/images/part/notification_history.png new file mode 100644 index 0000000..e312899 Binary files /dev/null and b/docs/assets/images/part/notification_history.png differ diff --git a/docs/assets/images/part/notification_inbox.png b/docs/assets/images/part/notification_inbox.png new file mode 100644 index 0000000..06e9662 Binary files /dev/null and b/docs/assets/images/part/notification_inbox.png differ diff --git a/docs/part/notification.md b/docs/part/notification.md index fccbfb6..ddfce40 100644 --- a/docs/part/notification.md +++ b/docs/part/notification.md @@ -2,16 +2,46 @@ title: Part Notifications --- -## Notification Events +## General Notification Details -Users can select to receive email notifications when certain events occur. +Users can select to receive notifications when certain events occur. !!! warning "Email Configuration Required" - Notifications require correct [email configuration](../../start/config/#email-settings) + External notifications require correct [email configuration](../../start/config/#email-settings). They also need to be enabled in the settings under notifications`. !!! warning "Valid Email Address" Each user must have a valid email address associated with their account to receive email notifications +Notifications are also shown in the user interface. New notifications are announced in the header. +{% with id="notification_header", url="part/notification_header.png", description="One new notification in the header" %} +{% include 'img.html' %} +{% endwith %} + +They can be viewed in a flyout. +{% with id="notification_flyout", url="part/notification_flyout.png", description="One new notification in the flyout" %} +{% include 'img.html' %} +{% endwith %} + +All current notifications are listed in the inbox. +{% with id="notification_inbox", url="part/notification_inbox.png", description="One new notification in the notification inbox" %} +{% include 'img.html' %} +{% endwith %} + +All past notification are listed in the history. They can be deleted one-by-one or all at once from there. +{% with id="notification_history", url="part/notification_history.png", description="One old notification in the notification history" %} +{% include 'img.html' %} +{% endwith %} + +## Subscription List + +Users can view the parts and categories they are subscribed to on the InvenTree home page: + +{% with id="cat_subs", url="part/cat_subs.png", description="Category subscription list" %} +{% include 'img.html' %} +{% endwith %} + +## Part Notification Events + ### Low Stock Notification If the *minimum stock* threshold is set for a *Part*, then a "low stock" notification can be generated when the stock level for that part falls below the configured level. @@ -63,11 +93,3 @@ Subscribing to a part category operates in the same manner as for a part - simpl {% with id="cat_sub", url="part/category_notification.png", description="Subscribe to part category" %} {% include 'img.html' %} {% endwith %} - -## Subscription List - -Users can view the parts and categories they are subscribed to on the InvenTree home page: - -{% with id="cat_subs", url="part/cat_subs.png", description="Category subscription list" %} -{% include 'img.html' %} -{% endwith %}