summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2021-06-30 23:43:58 +0100
committerGitHub <noreply@github.com>2021-06-30 23:43:58 +0100
commit04c8f308f453ee3d4fde453ed10c500cdc06b89e (patch)
tree1d814b2b0d30948155d05982bf701411256b7db3
parentChange more stream_ordering columns to BIGINT (#10286) (diff)
downloadsynapse-04c8f308f453ee3d4fde453ed10c500cdc06b89e.tar.xz
Fix the homeserver config example in presence router docs (#10288)
The presence router docs include some sample homeserver config. At some point we changed the name of the [config option](https://github.com/matrix-org/synapse/blob/859dc05b3692a3672c1a0db8deaaa9274b6aa6f5/docs/sample_config.yaml#L104-L113), but forgot to update the docs.

I've also added `presence.enabled: true` to the example, as that's the new way to enable presence (the `presence_enabled` option has been deprecated).
-rw-r--r--changelog.d/10288.doc1
-rw-r--r--docs/presence_router_module.md4
2 files changed, 4 insertions, 1 deletions
diff --git a/changelog.d/10288.doc b/changelog.d/10288.doc
new file mode 100644
index 0000000000..0739687b92
--- /dev/null
+++ b/changelog.d/10288.doc
@@ -0,0 +1 @@
+Fix homeserver config option name in presence router documentation.
diff --git a/docs/presence_router_module.md b/docs/presence_router_module.md
index bf859e4254..4a3e720240 100644
--- a/docs/presence_router_module.md
+++ b/docs/presence_router_module.md
@@ -222,7 +222,9 @@ Synapse, amend your homeserver config file with the following.
 
 ```yaml
 presence:
-  routing_module:
+  enabled: true
+
+  presence_router:
     module: my_module.ExamplePresenceRouter
     config:
       # Any configuration options for your module. The below is an example.