summary refs log tree commit diff
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2022-04-25 11:43:59 -0700
committerGitHub <noreply@github.com>2022-04-25 11:43:59 -0700
commite75c7e3b6ddc25b76b4eabf10eca1e923048ae43 (patch)
treebec7374fa98b264fb82bf34dadc18867cda51981
parentHandle cancellation in `EventsWorkerStore._get_events_from_cache_or_db` (#12529) (diff)
downloadsynapse-e75c7e3b6ddc25b76b4eabf10eca1e923048ae43.tar.xz
Add a table of contents to config manual (#12527)
* Update config_documentation.md
-rw-r--r--changelog.d/12527.doc2
-rw-r--r--docs/usage/configuration/config_documentation.md46
2 files changed, 46 insertions, 2 deletions
diff --git a/changelog.d/12527.doc b/changelog.d/12527.doc
new file mode 100644
index 0000000000..e6907321e7
--- /dev/null
+++ b/changelog.d/12527.doc
@@ -0,0 +1,2 @@
+Add an index to the configuration manual.
+
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 9c864af6ec..968b0fbfaf 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -64,7 +64,49 @@ apply if you want your config file to be read properly. A few helpful things to
   In addition, each setting has an example of its usage, with the proper indentation
   shown. 
 
-  
+## Contents
+[Modules](#modules)
+
+[Server](#server)
+
+[Homeserver Blocking](#homeserver-blocking)
+
+[TLS](#tls)
+
+[Federation](#federation)
+
+[Caching](#caching)
+
+[Database](#database)
+
+[Logging](#logging)
+
+[Ratelimiting](#ratelimiting)
+
+[Media Store](#media-store)
+
+[Captcha](#captcha)
+
+[TURN](#turn)
+
+[Registration](#registration)
+
+[API Configuration](#api-configuration)
+
+[Signing Keys](#signing-keys)
+
+[Single Sign On Integration](#single-sign-on-integration)
+
+[Push](#push)
+
+[Rooms](#rooms)
+
+[Opentracing](#opentracing)
+
+[Workers](#workers)
+
+[Background Updates](#background-updates)
+
 ## Modules
 
 Server admins can expand Synapse's functionality with external modules.
@@ -3409,4 +3451,4 @@ background_updates:
     sleep_duration_ms: 300
     min_batch_size: 10
     default_batch_size: 50
-```
\ No newline at end of file
+```