Merge pull request #3617 from luixxiul/fix

Use a common expression for suggesting to uncomment and adjust configuration

docs/configuring-playbook-bot-baibot.md

@@ -186,7 +186,7 @@ matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_m
 # or you can adjust it below only for the Groq agent.
 # matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_prompt: "{{ matrix_bot_baibot_config_agents_static_definitions_prompt }}"
 
-# Uncomment and adjust if you're not happy with these speech-to-text defaults:
+# Uncomment and adjust this part if you're not happy with these speech-to-text defaults:
 #
 # matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_enabled: true
 # matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_model_id: whisper-large-v3
@@ -217,7 +217,7 @@ matrix_bot_baibot_config_agents_static_definitions_mistral_config_api_key: "YOUR
 # or you can adjust it below only for the Mistral agent.
 # matrix_bot_baibot_config_agents_static_definitions_mistral_config_text_generation_prompt: "{{ matrix_bot_baibot_config_agents_static_definitions_prompt }}"
 
-# Uncomment and adjust if you're not happy with these defaults:
+# Uncomment and adjust this part if you're not happy with these defaults:
 # matrix_bot_baibot_config_agents_static_definitions_mistral_config_text_generation_model_id: mistral-large-latest
 
 # See `defaults/main.yml` in the baibot role for more configuration options.

docs/configuring-playbook-bot-honoroit.md

@@ -14,7 +14,7 @@ Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.
 ```yaml
 matrix_bot_honoroit_enabled: true
 
-# Uncomment and adjust if you'd like to change the hostname or path
+# Uncomment and adjust this part if you'd like to use a hostname or path different than the default
 # matrix_bot_honoroit_hostname: "{{ matrix_server_fqn_matrix }}"
 # matrix_bot_honoroit_path_prefix: /honoroit
 

docs/configuring-playbook-cactus-comments.md

@@ -38,7 +38,7 @@ matrix_cactus_comments_enabled: true
 # but we explicitly enable it here.
 matrix_cactus_comments_client_enabled: true
 
-# Uncomment and adjust if you'd like to host the client assets at a different location.
+# Uncomment and adjust this part if you'd like to host the client assets at a different location.
 # These variables are only make used if (`matrix_cactus_comments_client_enabled: true`)
 # matrix_cactus_comments_client_hostname: "{{ matrix_server_fqn_matrix }}"
 # matrix_cactus_comments_client_path_prefix: /cactus-comments

docs/configuring-playbook-etherpad.md

@@ -35,7 +35,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra
 ```yaml
 etherpad_enabled: true
 
-# Uncomment and adjust if you'd like to enable the admin web UI
+# Uncomment and adjust this part if you'd like to enable the admin web UI
 # etherpad_admin_username: YOUR_USERNAME_HERE
 # etherpad_admin_password: YOUR_PASSWORD_HERE
 ```

docs/configuring-playbook-jitsi.md

@@ -24,10 +24,10 @@ Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.
 ```yaml
 jitsi_enabled: true
 
-# Uncomment and adjust if you need to use another hostname
+# Uncomment and adjust this part if you'd like to use a hostname different than the default
 # jitsi_hostname: "jitsi.{{ matrix_domain }}"
 
-# Uncomment and possible adjust if you'd like to host under a subpath
+# Uncomment and possible adjust this part if you'd like to host under a subpath
 # jitsi_path_prefix: /jitsi
 ```
 

docs/configuring-playbook-ntfy.md

@@ -17,8 +17,7 @@ Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.
 # Enabling it is the only required setting
 ntfy_enabled: true
 
-# This is the default hostname.
-# Uncomment the line below and change it, if you'd like.
+# Uncomment and adjust this part if you'd like to use a hostname different than the default
 # matrix_server_fqn_ntfy: "ntfy.{{ matrix_domain }}"
 
 # Uncomment to enable the ntfy web app (disabled by default)

docs/configuring-playbook-own-webserver.md

@@ -32,7 +32,7 @@ Traefik will manage SSL certificates for all services seamlessly.
 ```yaml
 matrix_playbook_reverse_proxy_type: other-traefik-container
 
-# Uncomment and adjust if your Traefik container is on another network
+# Uncomment and adjust this part if your Traefik container is on another network
 # matrix_playbook_reverse_proxy_container_network: traefik
 
 # Adjust to point to your Traefik container
@@ -40,7 +40,7 @@ matrix_playbook_reverse_proxy_hostname: name-of-your-traefik-container
 
 traefik_certs_dumper_ssl_dir_path: "/path/to/your/traefiks/acme.json/directory"
 
-# Uncomment and tweak the variable below if the name of your federation entrypoint is different
+# Uncomment and adjust the variable below if the name of your federation entrypoint is different
 # than the default value (matrix-federation).
 # matrix_federation_traefik_entrypoint_name: matrix-federation
 ```

docs/configuring-playbook-synapse-auto-accept-invite.md

@@ -38,7 +38,7 @@ Here's example configuration for using the **native** Synapse feature:
 ```yml
 matrix_synapse_auto_accept_invites_enabled: true
 
-# Default settings below. Uncomment and adjust if necessary.
+# Default settings below. Uncomment and adjust this part if necessary.
 # matrix_synapse_auto_accept_invites_only_for_direct_messages: false
 # matrix_synapse_auto_accept_invites_only_from_local_users: false