Merge pull request #3601 from luixxiul/fix

Make expression related to "Note" consistent

docs/configuring-dns.md

@@ -89,7 +89,7 @@ To make the [ma1sd](https://github.com/ma1uta/ma1sd) Identity Server (which this
 
 This is an optional feature for the optionally-installed [ma1sd service](configuring-playbook-ma1sd.md). See [ma1sd's documentation](https://github.com/ma1uta/ma1sd/wiki/mxisd-and-your-privacy#choices-are-never-easy) for information on the privacy implications of setting up this SRV record.
 
-Note: This `_matrix-identity._tcp` SRV record for the identity server is different from the `_matrix._tcp` that can be used for Synapse delegation. See [howto-server-delegation.md](howto-server-delegation.md) for more information about delegation.
+**Note**: This `_matrix-identity._tcp` SRV record for the identity server is different from the `_matrix._tcp` that can be used for Synapse delegation. See [howto-server-delegation.md](howto-server-delegation.md) for more information about delegation.
 
 When you're done with the DNS configuration and ready to proceed, continue with [Getting the playbook](getting-the-playbook.md).
 

docs/configuring-playbook-bot-baibot.md

@@ -357,7 +357,7 @@ You can configure the **initial values** for these via Ansible, via the `matrix_
 Example **additional** `vars.yml` configuration:
 
 ```yml
-# NOTE: these are initial defaults for the bot's global configuration.
+# Note: these are initial defaults for the bot's global configuration.
 # As such, changing any of these values subsequently has no effect on the bot's behavior.
 # Once initially configured, the global configuration is managed via bot commands, not via Ansible.
 

docs/configuring-playbook-bot-buscarron.md

@@ -79,7 +79,7 @@ To use the bot, invite the `@bot.buscarron:DOMAIN` to the room you specified in
 </form>
 ```
 
-**NOTE**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:
+**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:
 
 - if you hit the homepage (HTTP `GET` request to `/`)
 - if you submit a form to the wrong URL (`POST` request to `/non-existing-form`)

docs/configuring-playbook-bridge-appservice-discord.md

@@ -28,7 +28,7 @@ matrix_appservice_discord_bot_token: "YOUR DISCORD APP BOT TOKEN"
 matrix_synapse_configuration_extension_yaml: |
   use_appservice_legacy_authorization: true
 ```
-*Note*: This deprecated method is considered insecure.
+**Note**: This deprecated method is considered insecure.
 
 6. If you've already installed Matrix services using the playbook before, you'll need to re-run it (`--tags=setup-all,start`). If not, proceed with [configuring other playbook services](configuring-playbook.md) and then with [Installing](installing.md). Get back to this guide once ready.
 
@@ -42,14 +42,14 @@ Self-service bridging allows you to bridge specific and existing Matrix rooms to
 matrix_appservice_discord_bridge_enableSelfServiceBridging: true
 ```
 
-_Note: If self-service bridging is not enabled, `!discord help` commands will return no results._
+**Note**: If self-service bridging is not enabled, `!discord help` commands will return no results.
 
 Once self-service is enabled:
 
 1. Start a chat with `@_discord_bot:<YOUR_DOMAIN>` and say `!discord help bridge`.
 2. Follow the instructions in the help output message. If the bot is not already in the Discord server, follow the provided invite link. This may require you to be a administrator of the Discord server.
 
-_Note: Encrypted Matrix rooms are not supported as of writing._
+**Note**: Encrypted Matrix rooms are not supported as of writing.
 
 On the Discord side, you can say `!matrix help` to get a list of available commands to manage the bridge and Matrix users.
 

docs/configuring-playbook-bridge-appservice-kakaotalk.md

@@ -2,7 +2,7 @@
 
 The playbook can install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) for you. `matrix-appservice-kakaotalk` is a bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code.
 
-**NOTE**: there have been recent reports (~2022-09-16) that **using this bridge may get your account banned**.
+**Note**: there have been recent reports (~2022-09-16) that **using this bridge may get your account banned**.
 
 See the project's [documentation](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) to learn what it does and why it might be useful to you.
 

docs/configuring-playbook-bridge-appservice-slack.md

@@ -73,7 +73,7 @@ Note that the bot's domain is your server's domain **without the `matrix.` prefi
 
     - files:write:user
 
-    Note: In order to make Slack files visible to matrix users, this bridge will make Slack files visible to anyone with the url (including files in private channels). This is different than the current behavior in Slack, which only allows authenticated access to media posted in private channels. See MSC701 for details.
+    **Note**: In order to make Slack files visible to matrix users, this bridge will make Slack files visible to anyone with the url (including files in private channels). This is different than the current behavior in Slack, which only allows authenticated access to media posted in private channels. See MSC701 for details.
 
 9. Click on Install App and Install App to Workspace. Note the access tokens shown. You will need the Bot User OAuth Access Token and if you want to bridge files, the OAuth Access Token whenever you link a room.
 

docs/configuring-playbook-bridge-appservice-webhooks.md

@@ -2,7 +2,7 @@
 
 The playbook can install and configure [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks) for you.
 
-Note: This bridge is no longer maintained. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/Half-Shot/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md).
+**Note**: This bridge is no longer maintained. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/Half-Shot/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md).
 
 This bridge provides support for Slack-compatible webhooks.
 
@@ -20,7 +20,7 @@ matrix_appservice_webhooks_api_secret: '<your_secret>'
 2. In case you want to change the verbosity of logging via `journalctl -fu matrix-appservice-webhooks.service`
 you can adjust this in `inventory/host_vars/matrix.<domain-name>/vars.yml` as well.
 
-*Note*: default value is: `info` and availabe log levels are : `info`, `verbose`
+**Note**: default value is: `info` and availabe log levels are : `info`, `verbose`
 
 ```yaml
 matrix_appservice_webhooks_log_level: '<log_level>'
@@ -31,7 +31,7 @@ matrix_appservice_webhooks_log_level: '<log_level>'
 matrix_synapse_configuration_extension_yaml: |
   use_appservice_legacy_authorization: true
 ```
-*Note*: This deprecated method is considered insecure.
+**Note**: This deprecated method is considered insecure.
 
 4. If you've already installed Matrix services using the playbook before, you'll need to re-run it (`--tags=setup-all,start`). If not, proceed with [configuring other playbook services](configuring-playbook.md) and then with [Installing](installing.md). Get back to this guide once ready.
 
@@ -39,7 +39,7 @@ matrix_synapse_configuration_extension_yaml: |
 
 6. Invite the bridge bot user to your room:
 
-    - either with `/invite @_webhook:<domain.name>` (*Note*: Make sure you have administration permissions in your room)
+    - either with `/invite @_webhook:<domain.name>` (**Note**: Make sure you have administration permissions in your room)
 
     - or simply add the bridge bot to a private channel (personal channels imply you being an administrator)
 

docs/configuring-playbook-conduit.md

@@ -2,7 +2,7 @@
 
 By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Conduit](https://conduit.rs).
 
-**NOTES**:
+**Notes**:
 
 - **You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Conduit). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet.
 

docs/configuring-playbook-dendrite.md

@@ -2,7 +2,7 @@
 
 By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Dendrite](https://github.com/matrix-org/dendrite).
 
-**NOTES**:
+**Notes**:
 
 - **You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Dendrite). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet.
 
@@ -29,4 +29,3 @@ To use Dendrite, you **generally** need the following additional `vars.yml` conf
 ```yaml
 matrix_homeserver_implementation: dendrite
 ```
-

docs/configuring-playbook-external-postgres.md

@@ -5,7 +5,7 @@ If that's alright, you can skip this.
 
 If you'd like to use an external PostgreSQL server that you manage, you can edit your configuration file  (`inventory/host_vars/matrix.<your-domain>/vars.yml`).
 
-**NOTE**: using **an external Postgres server is currently [not very seamless](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1682#issuecomment-1061461683) when it comes to enabling various other playbook services** - you will need to create a new database/credentials for each service and to point each service to its corresponding database using custom `vars.yml` configuration. **For the best experience with the playbook, stick to using the integrated Postgres server**.
+**Note**: using **an external Postgres server is currently [not very seamless](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1682#issuecomment-1061461683) when it comes to enabling various other playbook services** - you will need to create a new database/credentials for each service and to point each service to its corresponding database using custom `vars.yml` configuration. **For the best experience with the playbook, stick to using the integrated Postgres server**.
 
 If you'd like to use an external Postgres server, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (adapt to your needs):
 

docs/configuring-playbook-jitsi.md

@@ -40,7 +40,7 @@ If you're fine with such an open Jitsi instance, please skip to [Apply changes](
 If you would like to control who is allowed to open meetings on your new Jitsi instance, then please follow the following steps to enable Jitsi's authentication and optionally guests mode.
 Currently, there are three supported authentication modes: 'internal' (default), 'matrix' and 'ldap'.
 
-**Note:** Authentication is not tested via the playbook's self-checks.
+**Note**: Authentication is not tested via the playbook's self-checks.
 We therefore recommend that you manually verify if authentication is required by jitsi.
 For this, try to manually create a conference on jitsi.DOMAIN in your browser.
 

docs/configuring-playbook-matrix-ldap-registration-proxy.md

@@ -4,7 +4,7 @@ The playbook can install and configure [matrix-ldap-registration-proxy](https://
 
 This proxy handles Matrix registration requests and forwards them to LDAP.
 
-**Please note:** This does support the full Matrix specification for registrations. It only provide a very coarse
+**Note**: This does support the full Matrix specification for registrations. It only provide a very coarse
 implementation of a basic password registration.
 
 ## Quickstart

docs/configuring-playbook-prometheus-nginxlog.md

@@ -6,7 +6,7 @@ This adds [prometheus-nginxlog-exporter](https://github.com/martin-helmich/prome
 
 It will collect access logs from various nginx reverse-proxies which may be used internally (e.g. `matrix-synapse-reverse-proxy-companion`, if Synapse workers are enabled) and will make them available at a Prometheus-compatible `/metrics` endpoint.
 
-**NOTE**: nginx is only used internally by this Ansible playbook. With Traefik being our default reverse-proxy, collecting nginx metrics is less relevant.
+**Note**: nginx is only used internally by this Ansible playbook. With Traefik being our default reverse-proxy, collecting nginx metrics is less relevant.
 
 To make use of this, you need to install [Prometheus](./configuring-playbook-prometheus-grafana.md) either via the playbook or externally. When using an external Prometheus, configuration adjustments are necessary - see [Save metrics on an external Prometheus server](#save-metrics-on-an-external-prometheus-server).
 

docs/configuring-playbook-s3.md

@@ -65,7 +65,7 @@ You'll need an Amazon S3 bucket and some IAM user credentials (access key + secr
 }
 ```
 
-**NOTE**: This policy needs to be attached to an IAM user created from the **Security Credentials** menu. This is not a **Bucket Policy**.
+**Note**: This policy needs to be attached to an IAM user created from the **Security Credentials** menu. This is not a **Bucket Policy**.
 
 
 ## Backblaze B2

docs/configuring-playbook-sliding-sync-proxy.md

@@ -10,7 +10,7 @@ Element X iOS is [available on TestFlight](https://testflight.apple.com/join/uZb
 
 Element X Android is [available on the Github Releases page](https://github.com/element-hq/element-x-android/releases).
 
-**NOTE**: The sliding-sync proxy is **not required** when using the **Conduit homeserver**. Starting from version `0.6.0` Conduit has native support for some sliding sync features. If there are issues with the native implementation, you might have a better experience when enabling the sliding-sync proxy anyway.
+**Note**: The sliding-sync proxy is **not required** when using the **Conduit homeserver**. Starting from version `0.6.0` Conduit has native support for some sliding sync features. If there are issues with the native implementation, you might have a better experience when enabling the sliding-sync proxy anyway.
 
 ## Decide on a domain and path
 

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

@@ -5,7 +5,7 @@ The playbook can install and configure [synapse-auto-invite-accept](https://gith
 See that project's [documentation](https://github.com/matrix-org/synapse-auto-accept-invite) to learn what it does and why it might be useful to you.
 In short, it automatically accepts room invites. You can specify that only 1:1 room invites are auto-accepted. Defaults to false if not specified.
 
-**NOTE**: Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the same feature [has been merged](https://github.com/element-hq/synapse/pull/17147) into Synapse (see the [Native alternative](#native-alternative) section below). You'd better use the native feature, instead of the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module.
+**Note**: Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the same feature [has been merged](https://github.com/element-hq/synapse/pull/17147) into Synapse (see the [Native alternative](#native-alternative) section below). You'd better use the native feature, instead of the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module.
 
 
 ## Configuration

docs/howto-server-delegation.md

@@ -35,7 +35,7 @@ Otherwise, you can decide to go against the default for this playbook, and inste
 
 ## Server Delegation via a DNS SRV record (advanced)
 
-**NOTE**: doing Server Delegation via a DNS SRV record is a more **advanced** way to do it and is not the default for this playbook. This is usually **much more complicated** to set up, so **we don't recommend it**. If you're not an experience sysadmin, you'd better stay away from this.
+**Note**: doing Server Delegation via a DNS SRV record is a more **advanced** way to do it and is not the default for this playbook. This is usually **much more complicated** to set up, so **we don't recommend it**. If you're not an experience sysadmin, you'd better stay away from this.
 
 As per the [Server-Server spec](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), it's possible to do Server Delegation using only a SRV record (without a `/.well-known/matrix/server` file).
 

docs/howto-srv-server-delegation.md

@@ -16,7 +16,7 @@ The up-to-date list can be accessed on [traefik's documentation](https://doc.tra
 
 ## The changes
 
-**NOTE**: the changes below instruct you how to do this for a basic Synapse installation. You will need to adapt the variable name and the content of the labels:
+**Note**: the changes below instruct you how to do this for a basic Synapse installation. You will need to adapt the variable name and the content of the labels:
 
 - if you're using another homeserver implementation (e.g. [Conduit](./configuring-playbook-conduit.md) or [Dendrite](./configuring-playbook-dendrite.md))
 - if you're using [Synapse with workers enabled](./configuring-playbook-synapse.md#load-balancing-with-workers) (`matrix_synapse_workers_enabled: true`). In that case, it's actually the `matrix-synapse-reverse-proxy-companion` service which has Traefik labels attached

docs/installing.md

@@ -108,6 +108,6 @@ After you have started the services and **finalized the installation process** (
 - or learn how to [upgrade services when new versions are released](maintenance-upgrading-services.md)
 - or learn how to [maintain your server](faq.md#maintenance)
 - or join some Matrix rooms:
-  * via the *Explore rooms* feature in Element or some other client, or by discovering them using this [matrix-static list](https://view.matrix.org). Note: joining large rooms may overload small servers.
+  * via the *Explore rooms* feature in Element or some other client, or by discovering them using this [matrix-static list](https://view.matrix.org). **Note**: joining large rooms may overload small servers.
   * or come say Hi in our support room - [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting.
 - or help make this playbook better by contributing (code, documentation, or [coffee/beer](https://liberapay.com/s.pantaleev/donate))

examples/reverse-proxies/caddy2-in-container/README.md

@@ -2,7 +2,7 @@
 
 This directory contains a sample config that shows you how to front the integrated [Traefik](https://traefik.io/) reverse-proxy webserver with your own **containerized** [Caddy](https://caddyserver.com/) reverse-proxy. If you have a server with a Caddy container already serving several applications and you want to install Matrix on it (with no changes to existing traffic routing), then this guide is for you.
 
-Note: if you're running Caddy on the host itself (not in a container), refer to the [caddy2](../caddy2/README.md) example instead.
+**Note**: if you're running Caddy on the host itself (not in a container), refer to the [caddy2](../caddy2/README.md) example instead.
 
 
 ## Prerequisite configuration

roles/custom/matrix-bridge-appservice-irc/tasks/migrate_nedb_to_postgres.yml

@@ -73,6 +73,6 @@
         devture_playbook_runtime_messages_list | default([])
         +
         [
-          "NOTE: Your appservice-irc database files have been imported into Postgres. The original database files have been moved from `{{ matrix_appservice_irc_data_path }}/*.db` to `{{ matrix_appservice_irc_data_path }}/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files."
+          "Note: Your appservice-irc database files have been imported into Postgres. The original database files have been moved from `{{ matrix_appservice_irc_data_path }}/*.db` to `{{ matrix_appservice_irc_data_path }}/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files."
         ]
       }}

roles/custom/matrix-bridge-appservice-slack/tasks/migrate_nedb_to_postgres.yml

@@ -69,6 +69,6 @@
         devture_playbook_runtime_messages_list | default([])
         +
         [
-          "NOTE: Your appservice-slack database files have been imported into Postgres. The original database files have been moved from `{{ matrix_appservice_slack_data_path }}/*.db` to `{{ matrix_appservice_slack_data_path }}/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files."
+          "Note: Your appservice-slack database files have been imported into Postgres. The original database files have been moved from `{{ matrix_appservice_slack_data_path }}/*.db` to `{{ matrix_appservice_slack_data_path }}/*.db.backup`. When you've confirmed that the import went well and everything works, you should be able to safely delete these files."
         ]
       }}

roles/custom/matrix-bridge-mautrix-facebook/tasks/validate_config.yml

@@ -34,6 +34,6 @@
             devture_playbook_runtime_messages_list | default([])
             +
             [
-              "NOTE: Your mautrix-facebook bridge is still on SQLite and on the last version that supported it, before support was dropped. Support has been subsequently re-added in v0.3.2, so we advise you to upgrade (by removing your `matrix_mautrix_facebook_docker_image` definition from vars.yml)"
+              "Note: Your mautrix-facebook bridge is still on SQLite and on the last version that supported it, before support was dropped. Support has been subsequently re-added in v0.3.2, so we advise you to upgrade (by removing your `matrix_mautrix_facebook_docker_image` definition from vars.yml)"
             ]
           }}

roles/custom/matrix-coturn/tasks/setup_install.yml

@@ -7,7 +7,7 @@
       ansible.builtin.fail:
         msg: "To use the external IP address auto-detection feature, you need to set matrix_coturn_turn_external_ip_address_auto_detection_echoip_service_url"
 
-    # NOTE:
+    # Note:
     # `ansible.builtin.uri` does not provide a way to configure whether IPv4 or IPv6 is used.
     # Luckily, the default instance we use does not define AAAA records for now, so it's always IPv4.
     - name: Fetch IP address information from EchoIP service

roles/custom/matrix-prometheus-nginxlog-exporter/defaults/main.yml

@@ -87,7 +87,7 @@ matrix_prometheus_nginxlog_exporter_container_http_host_bind_port: ''
 # Controls whether the matrix-prometheus_nginxlog_exporter container exposes its SYSLOG port (udp/6514 in the container).
 #
 # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:6514"), or empty string to not expose.
-# NOTE: is an UDP connection!
+# Note: is an UDP connection!
 matrix_prometheus_nginxlog_exporter_container_syslog_host_bind_port: ''
 
 matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags: "{{ matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_auto + matrix_prometheus_nginxlog_exporter_config_namespaces_matrix_source_tags_custom }}"

roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2

@@ -1581,7 +1581,7 @@ auto_accept_invites:
 enable_metrics: {{ matrix_synapse_metrics_enabled|to_json }}
 
 # Enable sentry integration
-# NOTE: While attempts are made to ensure that the logs don't contain
+# Note: While attempts are made to ensure that the logs don't contain
 # any sensitive information, this cannot be guaranteed. By enabling
 # this option the sentry server may therefore receive sensitive
 # information, and it in turn may then diseminate sensitive information