📝 Add documentation changelog, add configuration email

Georiviere · Jul 25, 2023 · 229aca9 · 229aca9
1 parent 9e19089
commit 229aca9
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -10,7 +10,8 @@ CHANGELOG
 * Add contributions type / category filters
 * Add contributions manager
 * Add contribution status
-
+* Send mail to managers when contribution is created
+* Send mail to contributor when contribution is created
 
 1.1.0        (2023-13-06)
 -------------------------

diff --git a/docs/usage/configuration.rst b/docs/usage/configuration.rst
@@ -1,3 +1,4 @@
+=============
 Configuration
 =============
 
@@ -63,4 +64,31 @@ To customize lists for each module, go to django administration page.
     * Cities
     * Districts
     * Restricted area types
-    * Restricted areas
+    * Restricted areas
+
+
+Email settings
+--------------
+
+Georiviere-admin will send emails:
+
+* to administrators when internal errors occur
+* to managers when a contribution is created
+* to contributors when a contribution is created
+
+Email configuration takes place in ``var/conf/custom.py``, where you control
+recipients emails (``ADMINS``, ``MANAGERS``) and email server configuration.
+
+You can test your configuration with the following command. A fake email will
+be sent to the managers:
+
+::
+
+    docker-compose run --rm web ./manage.py sendtestemail --managers
+
+If you don't want to send an email to contributors when they create a contribution on portal website,
+change this setting in ``var/conf/custom.py``:
+
+::
+
+    SEND_REPORT_ACK = False