update docs (#415)

bihealth · Apr 24, 2024 · 510d8bb · 510d8bb
1 parent e91df57
commit 510d8bb
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/docs/source/_static/app_adminalerts/alert_form.png b/docs/source/_static/app_adminalerts/alert_form.png
diff --git a/docs/source/app_adminalerts.rst b/docs/source/app_adminalerts.rst
@@ -120,6 +120,11 @@ Require Auth
     If set true, this alert will only be shown to users logged in to the site.
     If false, it will also appear in the login screen as well as for anonymous
     users if allowed on the site.
+Send Alert as Email
+    Send alert as email to all users with email notifications enabled, with the
+    exception of the sender. This is enabled by default when creating an alert.
+    When updating an existing alert it is initially disabled to avoid redundant
+    emails when e.g. fixing a typo.
 Description
     A longer description, which can be accessed through the :guilabel:`Details`
     link in the alert element. Markdown syntax is supported.

diff --git a/docs/source/app_userprofile.rst b/docs/source/app_userprofile.rst
@@ -81,6 +81,8 @@ app plugins.
 User settings defined in the ``projectroles`` app, available for all SODAR Core
 using sites:
 
+Receive Email for Admin Alerts
+    Receive email for :ref:`admin alerts <app_adminalerts>`.
 Display Project UUID Copying Link
     If set true, display a link in the project title bar for copying the project
     UUID into the clipboard.