Merge pull request #3978 from luixxiul/patch-2

Update roles/custom/matrix-bot-draupnir/defaults/main.yml

roles/custom/matrix-bot-draupnir/defaults/main.yml

@@ -49,13 +49,14 @@ matrix_bot_draupnir_systemd_wanted_services_list: []
 # Whether Draupnir should talk to the homeserver through Pantalaimon
 # If true, then other variables must be provided including pointing
 # `matrix_bot_draupnir_homeserver_url` to the Pantalaimon URL.
-# Enabling this option is discouraged, because Draupnir does not support
-# running with Pantalaimon as it would break all workflows that involve answering
-# prompts with reactions. (Hint: a lot of workflows rely on them.)
+#
+# The upstream project discourages enabling this option, because it is
+# known that running Draupnir along with Pantalaimon breaks all workflows that involve
+# answering prompts with reactions. (Hint: a lot of workflows rely on them.)
 matrix_bot_draupnir_pantalaimon_use: false
 
 # If you choose to accept the risks of using Pantalaimon in your installation
-# against the upstream advice, you can enable this to disable the warning about it.
+# against the upstream advice, you can enable this to disable the warning about using it.
 matrix_bot_draupnir_pantalaimon_breakage_ignore: false
 
 # Tells the bot if it should use its native E2EE support in the form of experimental Rust Crypto in the bot SDK.
@@ -63,22 +64,22 @@ matrix_bot_draupnir_pantalaimon_breakage_ignore: false
 # Rust Crypto requires a clean access token that has not touched E2EE so curl is recommended as a method to obtain it.
 matrix_bot_draupnir_enable_experimental_rust_crypto: false
 
-# The access token for the bot user. Required when NOT using Pantalaimon.
+# The access token for the bot user. Required if Pantalaimon is NOT used.
 # (Otherwise provide `matrix_bot_draupnir_pantalaimon_username` and `matrix_bot_draupnir_pantalaimon_password` instead.)
 matrix_bot_draupnir_access_token: ""
 
-# User name and password for the bot. Required when using Pantalaimon.
+# Username and password for the bot. Required if Pantalaimon is used.
 # (Otherwise provide `matrix_bot_draupnir_access_token` instead.)
 matrix_bot_draupnir_pantalaimon_username: ""
 matrix_bot_draupnir_pantalaimon_password: ""
 
-# Username and password the bot uses for logging in directly. If using Pantalimon
+# Username and password the bot uses for logging in directly. If Pantalaimon is used,
 # these values become the values of `matrix_bot_draupnir_pantalaimon_username` and `matrix_bot_draupnir_pantalaimon_password`
 matrix_bot_draupnir_login: "{{ matrix_bot_draupnir_pantalaimon_username if matrix_bot_draupnir_pantalaimon_use == 'true' else 'bot.draupnir' }}"
 matrix_bot_draupnir_password: "{{ matrix_bot_draupnir_pantalaimon_password }}"
 
-# Controls if we activate the pantalaimon config block for now. This configuration block is proable to change name for our usecase
-# due to a Draupnir push to scrub Pantalaimon from the codebase.
+# Controls if we activate the config block for Pantalaimon for now. Its name will
+# probably be changed for our usecase due to Draupnir's push to scrub Pantalaimon from the codebase.
 matrix_bot_draupnir_login_native: ""
 
 # The room ID where people can use the bot. The bot has no access controls, so
@@ -88,21 +89,21 @@ matrix_bot_draupnir_login_native: ""
 matrix_bot_draupnir_management_room: ""
 
 # Endpoint URL that Draupnir uses to interact with the Matrix homeserver (client-server API).
-# Set this to the pantalaimon URL if you're using that.
+# Set this to the Pantalaimon URL if you're using that.
 matrix_bot_draupnir_homeserver_url: ""
 
-# Endpoint URL that Draupnir could use to fetch events related to reports (client-server API and /_synapse/),
-# only set this to the public-internet homeserver client API URL, do NOT set this to the pantalaimon URL.
+# Endpoint URL that Draupnir could use to fetch events related to reports (client-server API and /_synapse/).
+# Only set this to the public-internet homeserver client API URL. Do NOT set this to the Pantalaimon URL.
 matrix_bot_draupnir_raw_homeserver_url: ""
 
-# Disable Server ACL is used if you want to not give the bot the right to apply Server ACLs in rooms without complaints from the bot.
-# This setting is described the following way in the Configuration.
+# Disable Server ACL is used if you do not want to give the bot the right to apply Server ACLs in rooms without complaints from the bot.
+# This setting is described the following way in the configuration.
 #
 # Whether or not Draupnir should apply `m.room.server_acl` events.
 # DO NOT change this to `true` unless you are very confident that you know what you are doing.
+# It is recommended to consult with people from the upstream project beforehand.
 #
-# Please follow the advice of upstream and only change this value if you know what your doing.
-# Its Exposed here because its common enough to be valid to expose.
+# It is exposed here because it is common enough to be valid to expose.
 matrix_bot_draupnir_disable_server_acl: "false"
 
 # Controls if the room state backing store is activated.