From 54e848da6a233d1711177875e62ee861a7f30ca6 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Mon, 16 May 2022 17:46:19 +0100 Subject: [PATCH 1/5] Switch the 'Configuration' link in the docs homepage to the config manual --- docs/welcome_and_overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/welcome_and_overview.md b/docs/welcome_and_overview.md index aab2d6b4f0f6..e3b689db7a81 100644 --- a/docs/welcome_and_overview.md +++ b/docs/welcome_and_overview.md @@ -10,7 +10,7 @@ This documentation covers topics for **installation**, **configuration** and **maintainence** of your Synapse process: * Learn how to [install](setup/installation.md) and - [configure](usage/configuration/index.html) your own instance, perhaps with [Single + [configure](usage/configuration/config_documentation.md) your own instance, perhaps with [Single Sign-On](usage/configuration/user_authentication/index.html). * See how to [upgrade](upgrade.md) between Synapse versions. From dc29d16f0bec620c9bf81ef9d151cf40d031d48b Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Mon, 16 May 2022 17:47:23 +0100 Subject: [PATCH 2/5] Change *.html links to *.md mdbook will automatically change these to their .html counterparts. --- docs/welcome_and_overview.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/welcome_and_overview.md b/docs/welcome_and_overview.md index e3b689db7a81..b7045b1114b2 100644 --- a/docs/welcome_and_overview.md +++ b/docs/welcome_and_overview.md @@ -11,13 +11,13 @@ This documentation covers topics for **installation**, **configuration** and * Learn how to [install](setup/installation.md) and [configure](usage/configuration/config_documentation.md) your own instance, perhaps with [Single - Sign-On](usage/configuration/user_authentication/index.html). + Sign-On](usage/configuration/user_authentication/README.md). * See how to [upgrade](upgrade.md) between Synapse versions. * Administer your instance using the [Admin - API](usage/administration/admin_api/index.html), installing [pluggable - modules](modules/index.html), or by accessing the [manhole](manhole.md). + API](usage/administration/admin_api/README.md), installing [pluggable + modules](modules/index.md), or by accessing the [manhole](manhole.md). * Learn how to [read log lines](usage/administration/request_log.md), configure [logging](usage/configuration/logging_sample_config.md) or set up [structured @@ -50,7 +50,7 @@ following documentation: issue](https://github.com/matrix-org/synapse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). * Understand [how Synapse is - built](development/internal_documentation/index.html), how to [migrate + built](development/internal_documentation/README.md), how to [migrate database schemas](development/database_schema.md), learn about [federation](federate.md) and how to [set up a local federation](federate.md#running-a-demo-federation-of-synapses) for development. From 317b147c914f76cf5b164a37555782d43c696430 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Mon, 16 May 2022 17:51:43 +0100 Subject: [PATCH 3/5] changelog --- changelog.d/12748.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/12748.doc diff --git a/changelog.d/12748.doc b/changelog.d/12748.doc new file mode 100644 index 000000000000..996ad3a1b926 --- /dev/null +++ b/changelog.d/12748.doc @@ -0,0 +1 @@ +Link to the configuration manual from the welcome page of the documentation. From 2b36eae31bd78f2dc601de447e5ecda5ee3f0b44 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Mon, 16 May 2022 18:25:00 +0100 Subject: [PATCH 4/5] fix some more typos --- docs/welcome_and_overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/welcome_and_overview.md b/docs/welcome_and_overview.md index b7045b1114b2..fca7d52eac85 100644 --- a/docs/welcome_and_overview.md +++ b/docs/welcome_and_overview.md @@ -7,7 +7,7 @@ team. ## Installing and using Synapse This documentation covers topics for **installation**, **configuration** and -**maintainence** of your Synapse process: +**maintenance** of your Synapse process: * Learn how to [install](setup/installation.md) and [configure](usage/configuration/config_documentation.md) your own instance, perhaps with [Single @@ -65,7 +65,7 @@ following documentation: Want to help keep Synapse going but don't know how to code? Synapse is a [Matrix.org Foundation](https://matrix.org) project. Consider becoming a -supportor on [Liberapay](https://liberapay.com/matrixdotorg), +supporter on [Liberapay](https://liberapay.com/matrixdotorg), [Patreon](https://patreon.com/matrixdotorg) or through [PayPal](https://paypal.me/matrixdotorg) via a one-time donation. From 7a15e1dace80fd6b70c11086592788681f7ae3ac Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 18 May 2022 12:00:20 +0100 Subject: [PATCH 5/5] Revert "Change *.html links to *.md" This reverts commit dc29d16f0bec620c9bf81ef9d151cf40d031d48b. --- docs/welcome_and_overview.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/welcome_and_overview.md b/docs/welcome_and_overview.md index fca7d52eac85..451759f06ec6 100644 --- a/docs/welcome_and_overview.md +++ b/docs/welcome_and_overview.md @@ -11,13 +11,13 @@ This documentation covers topics for **installation**, **configuration** and * Learn how to [install](setup/installation.md) and [configure](usage/configuration/config_documentation.md) your own instance, perhaps with [Single - Sign-On](usage/configuration/user_authentication/README.md). + Sign-On](usage/configuration/user_authentication/index.html). * See how to [upgrade](upgrade.md) between Synapse versions. * Administer your instance using the [Admin - API](usage/administration/admin_api/README.md), installing [pluggable - modules](modules/index.md), or by accessing the [manhole](manhole.md). + API](usage/administration/admin_api/index.html), installing [pluggable + modules](modules/index.html), or by accessing the [manhole](manhole.md). * Learn how to [read log lines](usage/administration/request_log.md), configure [logging](usage/configuration/logging_sample_config.md) or set up [structured @@ -50,7 +50,7 @@ following documentation: issue](https://github.com/matrix-org/synapse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). * Understand [how Synapse is - built](development/internal_documentation/README.md), how to [migrate + built](development/internal_documentation/index.html), how to [migrate database schemas](development/database_schema.md), learn about [federation](federate.md) and how to [set up a local federation](federate.md#running-a-demo-federation-of-synapses) for development.