From b94d4d1862acb7b3c0c79373fbb0966d5b6cbadc Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 15 Nov 2024 02:30:46 +0900 Subject: [PATCH] Establish a hierarchy among documentation pages related to installation; ones about importing data and configuring server delegation This commit clarifies the hierarchy among pages for installation by moving articles for importing data and server delegation under the "installation" section, as there are multiple documentation pages which discuss a similar topic and you can easily get lost in those pages. Also: remove the anchor link to configuring-playbook-base-domain-serving.md from configuring-playbook.md, since that procedure is not required on configuring options but on finalizing the installation, which is discussed on installing.md after that page. Signed-off-by: Suguru Hirahara --- docs/README.md | 26 ++++++++++++++++---------- docs/configuring-playbook.md | 2 -- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/docs/README.md b/docs/README.md index 3fdf8bd6a..87c84050f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,22 +12,28 @@ - [Installing](installing.md) + - **Importing data from another server installation** + + - [Importing an existing SQLite database (from another Synapse installation)](importing-synapse-sqlite.md) (optional) + + - [Importing an existing Postgres database (from another installation)](importing-postgres.md) (optional) + + - [Importing `media_store` data files from an existing Synapse installation](importing-synapse-media-store.md) (optional) + + - [Server Delegation](howto-server-delegation.md) + + - Server Delegation via a well-known file (recommended): [Installing well-known files on the base domain's server](configuring-well-known.md#installing-well-known-files-on-the-base-domain-s-server) + + - [Serving the base domain](configuring-playbook-base-domain-serving.md) + + - [Server Delegation via a DNS SRV record (advanced)](howto-srv-server-delegation.md) + - [Playbook tags](playbook-tags.md) -- **Importing data from another server installation** - - - [Importing an existing SQLite database (from another Synapse installation)](importing-synapse-sqlite.md) (optional) - - - [Importing an existing Postgres database (from another installation)](importing-postgres.md) (optional) - - - [Importing `media_store` data files from an existing Synapse installation](importing-synapse-media-store.md) (optional) - - [Registering users](registering-users.md) - [Updating users passwords](updating-users-passwords.md) -- [Configuring service discovery via .well-known](configuring-well-known.md) - - [Maintenance / checking if services work](maintenance-checking-services.md) - [Maintenance / upgrading services](maintenance-upgrading-services.md) diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 008acb934..620fbca19 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -64,8 +64,6 @@ When you're done with all the configuration you'd like to do, continue with [Ins - [Controlling Matrix federation](configuring-playbook-federation.md) -- [Serving the base domain](configuring-playbook-base-domain-serving.md) - ### Clients Web clients for Matrix that you can host on your own domains.