[pve-devel] [PATCH docs] notification mode: revise subchapter

[pve-devel] [PATCH docs] notification mode: revise subchapter

[Alexander Zeidler]

- Display the values and descriptions as a table.

`auto`:
- Rephrase the description so that the focus is on the recommended
  "notification-system" mode. This also fixes the incorrectly duplicated
  "if no email address is entered".
- Emphasize "Send email to".

`legacy-sendmail`:
- s/version/versions/
- Move/Append info about future removal of this mode.

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
---
 notifications.adoc | 29 ++++++++++++++---------------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/notifications.adoc b/notifications.adoc
index 331ac1d..f2e90f3 100644
--- a/notifications.adoc
+++ b/notifications.adoc
@@ -443,22 +443,21 @@ permissions on `/mapping/notifications`
 Notification Mode
 -----------------
 A backup job configuration has the `notification-mode`
-option which can have one of three values.
-
-* `auto`: Use the `legacy-sendmail` mode if no email address is entered in the
-  `mailto`/`Send email to` field. If no email address is entered,
-  the `notification-system` mode is used.
-
-* `legacy-sendmail`: Send notification emails via the system's `sendmail` command.
-  The notification system will be bypassed and any configured
-  targets/matchers will be ignored.
-  This mode is equivalent to the notification behavior for version before
-  {pve} 8.1 .
-
-* `notification-system`: Use the new, flexible notification system.
+option, which can have one of three values.
+
+[cols="30%m,70%"]
+|===
+| auto | If no email address is entered in the 'Send email to' field
+  (`mailto` option), use the recommended `notification-system` mode.
+  Otherwise use the `legacy-sendmail` mode.
+| legacy-sendmail | Send notification emails via the host's `sendmail`
+  command. The notification system will be bypassed and any of its
+  configured targets/matchers will be ignored. This mode is equivalent
+  to the notification behavior for versions before {pve} 8.1 . This
+  mode might be removed in a later release of {pve}.
+| notification-system | Use the new, flexible notification system.
+|===
 
 If the `notification-mode` option is not set, {pve} will default
 to `auto`.
 
-The `legacy-sendmail` mode might be removed in a later release of
-{pve}.
-- 
2.39.5



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel