[ADD] Referrals: new rewards doc

Signed-off-by: Lara Martini (larm) <larm@odoo.com> X-original-commit: 9feca1b4e4 [ADD] Referrals: new rewards doc closes odoo/documentation#9615 closes odoo/documentation#9755 Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-06-03 17:10:38 +00:00
parent 9a354654bb
commit f0a3f4cb41
4 changed files with 62 additions and 50 deletions
@@ -0,0 +1,60 @@
+======
+Alerts
+======
+
+In the *Referrals* application, it is possible to post a message, also referred to as an *alert*, at
+the top of the dashboard to share important information with users.
+
+Alerts remain on the main *Referrals* dashboard for the specified amount of time configured on the
+individual alert.
+
+.. image:: alerts/alerts.png
+   :align: center
+   :alt: Two alert banners appear above the user's photo.
+
+Create an alert
+===============
+
+Only users with *Administrator* access rights for the *Recruitment* application can create alerts.
+To add a new alert, navigate to the :menuselection:`Referrals app --> Configuration --> Alerts`.
+
+Click :guilabel:`New` to open a blank alert form. Enter the following information on the form:
+
+- :guilabel:`Date From`: the date the alert starts. On this date, the alert is visible on the
+  dashboard.
+- :guilabel:`Date To`: the date the alert ends. After this date, the alert is hidden from view.
+- :guilabel:`Company`: the current company populates this field, by default. To modify the company
+  the alert should be displayed for, select the desired company from the drop-down menu in this
+  field.
+
+  If this field remains blank, the alert is visible to everyone with access to the *Referrals*
+  application.
+
+  If a company is specified, only users within that company (who also have access to the *Referrals*
+  application) see the alert. This field **only** appears when in a multi-company database.
+- :guilabel:`Alert`: enter the text for the alert. This message appears inside the alert banner on
+  the main *Referrals* dashboard.
+- :guilabel:`On Click`: there are three options for the alert. Click the radio button next to the
+  desired selection. The options are:
+
+  - :guilabel:`Not Clickable`: the alert only displays text, there is no link to click.
+  - :guilabel:`Go to All Jobs`: the alert contains a link that, when clicked, navigates to the
+    website with all the job positions that are currently posted.
+  - :guilabel:`Specify URL`: the alert contains a link to a specific URL that, when clicked,
+    navigates to that URL. When selected, a :guilabel:`URL` field appears below the :guilabel:`On
+    Click` section. Enter the desired URL in that field.
+
+.. image:: alerts/alert-form.png
+   :align: center
+   :alt: An alert form completely filled in with all selections entered.
+
+Dismiss an alert
+================
+
+It is possible to dismiss an alert, if a user does not wish to see a specific alert again.
+
+To dismiss an alert, click the :icon:`fa-times` :guilabel:`(remove)` icon on the far-right side of
+the alert to remove the alert from the dashboard.
+
+This prevents the alert from appearing again, even when opening the *Referrals* application for the
+first time in a new session.