Skip to content

Commit 26c50f8

Browse files
committedSep 14, 2020
[docs] Various improvements to README
- Object Notification Preferences > Silencing notifications for specific objects temporarily or permanently - Added screenshot of widget that allows users to silence notifications - Ensure images are displayed after headings for consistency
1 parent 1885e8f commit 26c50f8

File tree

2 files changed

+32
-25
lines changed

2 files changed

+32
-25
lines changed
 

‎README.rst

+32-25
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,10 @@ Available features
5555
- `Web notifications <#web-notifications>`_
5656
- `Email notifications <#email-notifications>`_
5757
- `Configurable email theme <#openwisp_notifications_email_template>`_
58-
- `Definition of notification types <#notification-types>`_
59-
- `Possibility to register new notification types <#registering--unregistering-notification-types>`_
60-
- `Preference for receiving notifications <#notification-preferences>`_
58+
- `Notification types <#notification-types>`_
59+
- `Registering new notification types <#registering--unregistering-notification-types>`_
60+
- `User notification preferences <#notification-preferences>`_
61+
- `Silencing notifications for specific objects temporarily or permanently <#silencing-notifications-for-specific-objects-temporarily-or-permanently>`_
6162
- `Automatic cleanup of old notifications <#scheduled-deletion-of-notifications>`_
6263
- `Configurable host for API endpoints <#openwisp_notifications_host>`_
6364

@@ -346,6 +347,9 @@ web notifications:
346347
Notification Widget
347348
~~~~~~~~~~~~~~~~~~~
348349

350+
.. figure:: https://drive.google.com/uc?export=view&id=1EnjVxp_hjJEmUOTGyaqhd5uYCcyWnRaY
351+
:align: center
352+
349353
A javascript widget has been added to make consuming notifications easy for users.
350354
The notification widget provides following features:
351355

@@ -355,30 +359,27 @@ The notification widget provides following features:
355359
- Option to filter unread notifications.
356360
- Option to mark all notifications as read on a single click.
357361

358-
.. figure:: https://drive.google.com/uc?export=view&id=1EnjVxp_hjJEmUOTGyaqhd5uYCcyWnRaY
359-
:align: center
360-
361362
Notification Toasts
362363
~~~~~~~~~~~~~~~~~~~
363364

365+
.. figure:: https://drive.google.com/uc?export=view&id=1Lm0caDi3_DdiYzKc02DX3Cn2smj6ptWG
366+
:align: center
367+
364368
A notification toast delivers notifications at real-time. This allows
365369
users to read notifications without even opening the notification widget.
366370
A notification bell is also played to alert each time a notification is
367371
displayed through notification toast.
368372

369-
.. figure:: https://drive.google.com/uc?export=view&id=1Lm0caDi3_DdiYzKc02DX3Cn2smj6ptWG
370-
:align: center
371-
372373
Email Notifications
373374
-------------------
374375

376+
.. figure:: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/email-template.png
377+
375378
Along with web notifications *OpenWISP Notification* also sends notifications
376379
through emails.
377380

378381
Following notification email is generated by OpenWISP Notification in *OpenWISP Monitoring*:
379382

380-
.. figure:: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/email-template.png
381-
382383
Notification Cache
383384
------------------
384385

@@ -569,13 +570,13 @@ unregistered in ``ready`` method of your Django application's ``AppConfig``.
569570
Notification Preferences
570571
------------------------
571572

573+
.. image:: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/notification-settings.png
574+
572575
*openwisp-notifications* allows users to select their preferred way of receiving notifications.
573576
Users can choose from web or email notifications. These settings have been categorized
574577
over notification type and organization, therefore allowing users to only receive notifications
575578
from selected organization or notification type.
576579

577-
.. image:: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/notification-settings.png
578-
579580
Notification settings are automatically created for all notification types and organizations for all users.
580581
While superusers can add or delete notification settings for everyone, staff users can only modify their
581582
preferred ways for receiving notifications. With provided functionality, users can choose to receive both
@@ -586,15 +587,21 @@ by disabling both web and email option for a notification setting.
586587
then ``email_notification`` or ``web_notification`` option of concerned notification type will be used
587588
respectively.
588589

589-
Object Notification Preferences
590-
-------------------------------
591-
*OpenWISP Notifications* allows users to even define notification preferences based on target object.
592-
Users can disable notifications for any object for a desired period of time.
593-
Using the widget on an object's admin form, a user can disable notifications for that object
594-
for a day, week, month or even forever.
590+
Silencing notifications for specific objects temporarily or permanently
591+
-----------------------------------------------------------------------
592+
593+
.. image:: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/silence-notifications.png
595594

596-
**Note**: This feature requires configuring `"OPENWISP_NOTIFICATIONS_IGNORE_ENABLED_ADMIN" <#openwisp-notifications-object-notification-widget>`_
597-
to enable the widget on admin site of required models.
595+
*OpenWISP Notifications* allows users to silence all notifications generated by
596+
specific objects they are not interested in for a desired period of time or even permanently,
597+
while other users will keep receiving notifications normally.
598+
599+
Using the widget on an object's admin change form, a user can disable all notifications
600+
generated by that object for a day, week, month or permanently.
601+
602+
**Note**: This feature requires configuring
603+
`"OPENWISP_NOTIFICATIONS_IGNORE_ENABLED_ADMIN" <#openwisp_notifications_ignore_enabled_admin>`_
604+
to enable the widget in the admin section of the required models.
598605

599606
Scheduled deletion of notifications
600607
-----------------------------------
@@ -770,17 +777,17 @@ If you want cached notification content to never expire, then set it to ``None``
770777
Set it to ``0`` if you don't want to store notification contents in cache at all.
771778

772779
``OPENWISP_NOTIFICATIONS_IGNORE_ENABLED_ADMIN``
773-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
780+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
774781

775782
+-----------+-----------+
776783
| type | ``list`` |
777784
+-----------+-----------+
778785
| default | [] |
779786
+-----------+-----------+
780787

781-
This setting enables object notification widget on admin site of desired models which
782-
allows user to `disable notifications for that object. <#object-notification-preferences>`_.
783-
You are required to provide a list of dotted paths to desired model admin.
788+
This setting enables the widget which allows users to
789+
`silence notifications for specific objects temporarily or permanently. <#silencing-notifications-for-specific-objects-temporarily-or-permanently>`_
790+
in the change page of the specified ``ModelAdmin`` classes.
784791

785792
E.g., if you want to enable the widget for objects of ``openwisp_users.models.User``
786793
model, then configure the setting as following:

‎docs/images/silence-notifications.png

19.3 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.