Merge pull request #3617 from luixxiul/fix

Use a common expression for suggesting to uncomment and adjust configuration

docs/configuring-dns.md

@@ -71,7 +71,7 @@ The `sygnal.<your-domain>` subdomain may be necessary, because this playbook cou
 
 The `ntfy.<your-domain>` subdomain may be necessary, because this playbook could install the [ntfy](https://ntfy.sh/) UnifiedPush-compatible push notifications server. The installation of ntfy is disabled by default, it is not a core required component. To learn how to install it, see our [configuring ntfy guide](configuring-playbook-ntfy.md). If you do not wish to set up ntfy, feel free to skip the `ntfy.<your-domain>` DNS record.
 
-The `etherpad.<your-domain>` subdomain may be necessary, because this playbook could install the [Etherpad](https://etherpad.org/) a highly customizable open source online editor providing collaborative editing in really real-time. The installation of etherpad is disabled by default, it is not a core required component. To learn how to install it, see our [configuring etherpad guide](configuring-playbook-etherpad.md). If you do not wish to set up etherpad, feel free to skip the `etherpad.<your-domain>` DNS record.
+The `etherpad.<your-domain>` subdomain may be necessary, because this playbook could install the [Etherpad](https://etherpad.org/) a highly customizable open source online editor providing collaborative editing in really real-time. The installation of Etherpad is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Etherpad guide](configuring-playbook-etherpad.md). If you do not wish to set up Etherpad, feel free to skip the `etherpad.<your-domain>` DNS record.
 
 The `hydrogen.<your-domain>` subdomain may be necessary, because this playbook could install the [Hydrogen](https://github.com/element-hq/hydrogen-web) web client. The installation of Hydrogen is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Hydrogen guide](configuring-playbook-client-hydrogen.md). If you do not wish to set up Hydrogen, feel free to skip the `hydrogen.<your-domain>` DNS record.
 

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,9 +35,9 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra
 ```yaml
 etherpad_enabled: true
 
-# Uncomment below to enable the admin web UI
+# Uncomment and adjust this part if you'd like to enable the admin web UI
-# etherpad_admin_username: admin
+# etherpad_admin_username: YOUR_USERNAME_HERE
-# etherpad_admin_password: some-password
+# etherpad_admin_password: YOUR_PASSWORD_HERE
 ```
 
 ## Installing
@@ -62,12 +62,13 @@ Then from the plugin manager page (`https://etherpad.<your-domain>/admin/plugins
 
 This is how it works in Element, it might work quite similar with other clients:
 
-To integrate a standalone etherpad in a room, create your pad by visiting `https://etherpad.DOMAIN`. When the pad opens, copy the URL and send a command like this to the room: `/addwidget URL`. You will then find your integrated Etherpad within the right sidebar in the `Widgets` section.
+To integrate a standalone Etherpad in a room, create your pad by visiting `https://etherpad.DOMAIN`. When the pad opens, copy the URL and send a command like this to the room: `/addwidget URL`. You will then find your integrated Etherpad within the right sidebar in the `Widgets` section.
 
 
 ### Set Dimension default to the self-hosted Etherpad (optional)
 
 If you decided to install [Dimension integration manager](configuring-playbook-dimension.md) alongside Etherpad, the Dimension administrator users can configure the default URL template.
+
 The Dimension configuration menu can be accessed with the sprocket icon as you begin to add a widget to a room in Element. There you will find the Etherpad Widget Configuration action beneath the _Widgets_ tab.
 
 
@@ -81,4 +82,5 @@ Example: `https://etherpad.<your-domain>/p/$roomId_$padName?showChat=false`
 ## Known issues
 
 If your Etherpad widget fails to load, this might be due to Dimension generating a Pad name so long, the Etherpad app rejects it.
+
 `$roomId_$padName` can end up being longer than 50 characters. You can avoid having this problem by altering the template so it only contains the three word random identifier `$padName`.

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 and adjust this part if you'd like to use a hostname different than the default
-# Uncomment the line below and change it, if you'd like.
 # 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
 

roles/custom/matrix-base/defaults/main.yml

@@ -86,7 +86,7 @@ matrix_server_fqn_buscarron: "buscarron.{{ matrix_domain }}"
 # This is where you access the Dimension.
 matrix_server_fqn_dimension: "dimension.{{ matrix_domain }}"
 
-# This is where you access the etherpad (if enabled via etherpad_enabled; disabled by default).
+# This is where you access the Etherpad (if enabled via etherpad_enabled; disabled by default).
 matrix_server_fqn_etherpad: "etherpad.{{ matrix_domain }}"
 
 # For use with Go-NEB! (github callback url for example)

roles/custom/matrix-bridge-mautrix-meta-instagram/defaults/main.yml

@@ -13,7 +13,7 @@ matrix_mautrix_meta_instagram_enabled: true
 matrix_mautrix_meta_instagram_identifier: matrix-mautrix-meta-instagram
 
 # renovate: datasource=docker depName=dock.mau.dev/mautrix/meta
-matrix_mautrix_meta_instagram_version: v0.4.0
+matrix_mautrix_meta_instagram_version: v0.4.1
 
 matrix_mautrix_meta_instagram_base_path: "{{ matrix_base_data_path }}/mautrix-meta-instagram"
 matrix_mautrix_meta_instagram_config_path: "{{ matrix_mautrix_meta_instagram_base_path }}/config"

roles/custom/matrix-bridge-mautrix-meta-messenger/defaults/main.yml

@@ -13,7 +13,7 @@ matrix_mautrix_meta_messenger_enabled: true
 matrix_mautrix_meta_messenger_identifier: matrix-mautrix-meta-messenger
 
 # renovate: datasource=docker depName=dock.mau.dev/mautrix/meta
-matrix_mautrix_meta_messenger_version: v0.4.0
+matrix_mautrix_meta_messenger_version: v0.4.1
 
 matrix_mautrix_meta_messenger_base_path: "{{ matrix_base_data_path }}/mautrix-meta-messenger"
 matrix_mautrix_meta_messenger_config_path: "{{ matrix_mautrix_meta_messenger_base_path }}/config"

roles/custom/matrix-bridge-mautrix-signal/defaults/main.yml

@@ -9,7 +9,7 @@ matrix_mautrix_signal_container_image_self_build_repo: "https://mau.dev/mautrix/
 matrix_mautrix_signal_container_image_self_build_branch: "{{ 'main' if matrix_mautrix_signal_version == 'latest' else matrix_mautrix_signal_version }}"
 
 # renovate: datasource=docker depName=dock.mau.dev/mautrix/signal
-matrix_mautrix_signal_version: v0.7.1
+matrix_mautrix_signal_version: v0.7.2
 
 # See: https://mau.dev/mautrix/signal/container_registry
 matrix_mautrix_signal_docker_image: "{{ matrix_mautrix_signal_docker_image_name_prefix }}mautrix/signal:{{ matrix_mautrix_signal_docker_image_tag }}"

roles/custom/matrix-bridge-mautrix-slack/defaults/main.yml

@@ -9,7 +9,7 @@ matrix_mautrix_slack_container_image_self_build_repo: "https://mau.dev/mautrix/s
 matrix_mautrix_slack_container_image_self_build_branch: "{{ 'main' if matrix_mautrix_slack_version == 'latest' else matrix_mautrix_slack_version }}"
 
 # renovate: datasource=docker depName=dock.mau.dev/mautrix/slack
-matrix_mautrix_slack_version: v0.1.1
+matrix_mautrix_slack_version: v0.1.2
 # See: https://mau.dev/mautrix/slack/container_registry
 matrix_mautrix_slack_docker_image: "{{ matrix_mautrix_slack_docker_image_name_prefix }}mautrix/slack:{{ matrix_mautrix_slack_version }}"
 matrix_mautrix_slack_docker_image_name_prefix: "{{ 'localhost/' if matrix_mautrix_slack_container_image_self_build else 'dock.mau.dev/' }}"