From a4f9bdebcdc0b9b5c98977eac00beb57a4ffc088 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 11 Jan 2025 16:51:38 +0900 Subject: [PATCH] Update docs: adopt the common instruction Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-draupnir.md | 2 +- docs/configuring-playbook-client-cinny.md | 2 +- docs/configuring-playbook-client-hydrogen.md | 2 +- docs/configuring-playbook-client-schildichat-web.md | 2 +- docs/configuring-playbook-matrix-authentication-service.md | 2 +- docs/maintenance-checking-services.md | 2 +- docs/maintenance-postgres.md | 2 +- docs/prerequisites.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index fa3d3e555..a6f40897e 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -125,7 +125,7 @@ matrix_bot_draupnir_access_token: "ACCESS_TOKEN_HERE" Draupnir supports two methods to receive reports in the management room. -The first method intercepts the report API endpoint of the client-server API, which requires integration with the reverse proxy in front of the homeserver. If you are using traefik, this playbook can set this up for you: +The first method intercepts the report API endpoint of the client-server API, which requires integration with the reverse proxy in front of the homeserver. If you are using traefik, the playbook can set this up for you: ```yaml matrix_bot_draupnir_abuse_reporting_enabled: true diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md index de1bd6324..4e9decb4f 100644 --- a/docs/configuring-playbook-client-cinny.md +++ b/docs/configuring-playbook-client-cinny.md @@ -1,6 +1,6 @@ # Setting up Cinny (optional) -This playbook can install the [Cinny](https://github.com/ajbura/cinny) Matrix web client for you. +The playbook can install and configure the [Cinny](https://github.com/ajbura/cinny) Matrix web client for you. Cinny is a web client focusing primarily on simple, elegant and secure interface. It can be installed alongside or instead of [Element Web](./configuring-playbook-client-element-web.md). diff --git a/docs/configuring-playbook-client-hydrogen.md b/docs/configuring-playbook-client-hydrogen.md index a2926956d..db44e6a62 100644 --- a/docs/configuring-playbook-client-hydrogen.md +++ b/docs/configuring-playbook-client-hydrogen.md @@ -1,6 +1,6 @@ # Setting up Hydrogen (optional) -This playbook can install the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you. +The playbook can install and configure the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you. Hydrogen is a lightweight web client that supports mobile and legacy web browsers. It can be installed alongside or instead of Element Web. diff --git a/docs/configuring-playbook-client-schildichat-web.md b/docs/configuring-playbook-client-schildichat-web.md index 592809afe..e9781255a 100644 --- a/docs/configuring-playbook-client-schildichat-web.md +++ b/docs/configuring-playbook-client-schildichat-web.md @@ -1,6 +1,6 @@ # Setting up SchildiChat Web (optional) -This playbook can install the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) Matrix client for you. +The playbook can install and configure the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) Matrix client for you. SchildiChat Web is a feature-rich messenger for Matrix based on Element Web with some extras and tweaks. It can be installed alongside or instead of Element Web. diff --git a/docs/configuring-playbook-matrix-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index eb9ea08b9..616ab54cc 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -1,6 +1,6 @@ # Setting up Matrix Authentication Service (optional) -This playbook can install and configure [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service/) (MAS) - a service operating alongside your existing [Synapse](./configuring-playbook-synapse.md) homeserver and providing [better authentication, session management and permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/). +The playbook can install and configure [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service/) (MAS) - a service operating alongside your existing [Synapse](./configuring-playbook-synapse.md) homeserver and providing [better authentication, session management and permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/). Matrix Authentication Service is an implementation of [MSC3861: Next-generation auth for Matrix, based on OAuth 2.0/OIDC](https://github.com/matrix-org/matrix-spec-proposals/pull/3861) and still work in progress, tracked at the [areweoidcyet.com](https://areweoidcyet.com/) website. diff --git a/docs/maintenance-checking-services.md b/docs/maintenance-checking-services.md index d68502357..b2d90554c 100644 --- a/docs/maintenance-checking-services.md +++ b/docs/maintenance-checking-services.md @@ -1,6 +1,6 @@ # Checking if services work -This playbook can perform a check to ensure that you've configured things correctly and that services are running. +The playbook can perform a check to ensure that you've configured things correctly and that services are running. To perform the check, run: diff --git a/docs/maintenance-postgres.md b/docs/maintenance-postgres.md index c2b0b3020..82c4757c6 100644 --- a/docs/maintenance-postgres.md +++ b/docs/maintenance-postgres.md @@ -76,7 +76,7 @@ Once installed, the playbook attempts to preserve the Postgres version it starts Upgrades must be performed manually. -This playbook can upgrade your existing Postgres setup with the following command: +The playbook can upgrade your existing Postgres setup with the following command: ```sh just run-tags upgrade-postgres diff --git a/docs/prerequisites.md b/docs/prerequisites.md index a574c6352..8fb4b7a4e 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -28,7 +28,7 @@ We will be using `example.com` as the domain in the following instruction. Pleas - **Debian** (10/Buster or newer) - **Ubuntu** (18.04 or newer, although [20.04 may be problematic](ansible.md#supported-ansible-versions) if you run the Ansible playbook on it) - Generally, newer is better. We only strive to support released stable versions of distributions, not betas or pre-releases. This playbook can take over your whole server or co-exist with other services that you have there. + Generally, newer is better. We only strive to support released stable versions of distributions, not betas or pre-releases. The playbook can take over your whole server or co-exist with other services that you have there. This playbook somewhat supports running on non-`amd64` architectures like ARM. See [Alternative Architectures](alternative-architectures.md).