Fix room_list_publication_rules docs for v1.126.0 (#18286)
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2 files changed, 9 insertions, 7 deletions
diff --git a/changelog.d/18286.doc b/changelog.d/18286.doc
new file mode 100644
index 0000000000..37728351c5
--- /dev/null
+++ b/changelog.d/18286.doc
@@ -0,0 +1 @@
+Update `room_list_publication_rules` docs to consider defaults that changed in v1.126.0. Contributed by @HarHarLinks.
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 5351bef83a..2228c18a6c 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -4331,28 +4331,29 @@ room list by default_
Example configuration:
```yaml
-# No rule list specified. Anyone may publish any room to the public list.
+# No rule list specified. No one may publish any room to the public list, except server admins.
# This is the default behaviour.
room_list_publication_rules:
```
```yaml
-# A list of one rule which allows everything.
+# A list of one rule which denies everything.
# This has the same effect as the previous example.
room_list_publication_rules:
- - "action": "allow"
+ - "action": "deny"
```
```yaml
-# An empty list of rules. No-one may publish to the room list.
+# An empty list of rules.
+# This has the same effect as the previous example.
room_list_publication_rules: []
```
```yaml
-# A list of one rule which denies everything.
-# This has the same effect as the previous example.
+# A list of one rule which allows everything.
+# This was the default behaviour pre v1.126.0.
room_list_publication_rules:
- - "action": "deny"
+ - "action": "allow"
```
```yaml
|