From 789bf88b92063c4c12ac55526f53174cea9512f0 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 14 Oct 2024 22:35:16 +0900 Subject: [PATCH] Make "Note" consistent: wrap with wildcards Signed-off-by: Suguru Hirahara --- docs/configuring-dns.md | 2 +- docs/configuring-playbook-bridge-appservice-discord.md | 4 ++-- docs/configuring-playbook-bridge-appservice-slack.md | 2 +- docs/configuring-playbook-bridge-appservice-webhooks.md | 2 +- docs/configuring-playbook-jitsi.md | 2 +- docs/configuring-playbook-matrix-ldap-registration-proxy.md | 2 +- docs/installing.md | 2 +- examples/reverse-proxies/caddy2-in-container/README.md | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/configuring-dns.md b/docs/configuring-dns.md index 016aa99a1..70ac3517d 100644 --- a/docs/configuring-dns.md +++ b/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). diff --git a/docs/configuring-playbook-bridge-appservice-discord.md b/docs/configuring-playbook-bridge-appservice-discord.md index bd30d5aae..0e766af9c 100644 --- a/docs/configuring-playbook-bridge-appservice-discord.md +++ b/docs/configuring-playbook-bridge-appservice-discord.md @@ -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:` 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. diff --git a/docs/configuring-playbook-bridge-appservice-slack.md b/docs/configuring-playbook-bridge-appservice-slack.md index 5bf988268..6c2f830ee 100644 --- a/docs/configuring-playbook-bridge-appservice-slack.md +++ b/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. diff --git a/docs/configuring-playbook-bridge-appservice-webhooks.md b/docs/configuring-playbook-bridge-appservice-webhooks.md index 3a4c7ea5b..a2827e85c 100644 --- a/docs/configuring-playbook-bridge-appservice-webhooks.md +++ b/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. diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index c640a7f1b..de23cf127 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/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. diff --git a/docs/configuring-playbook-matrix-ldap-registration-proxy.md b/docs/configuring-playbook-matrix-ldap-registration-proxy.md index d72e82ab2..6ddcc0417 100644 --- a/docs/configuring-playbook-matrix-ldap-registration-proxy.md +++ b/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 diff --git a/docs/installing.md b/docs/installing.md index 78a4b0d84..b282b9734 100644 --- a/docs/installing.md +++ b/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)) diff --git a/examples/reverse-proxies/caddy2-in-container/README.md b/examples/reverse-proxies/caddy2-in-container/README.md index 783145de7..7a294f7ce 100644 --- a/examples/reverse-proxies/caddy2-in-container/README.md +++ b/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