dandri/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2026-09-10 09:26:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace manual notes in documentation with admonitions

Browse Source 
As they're generally prettier.

Requires https://github.com/element-hq/synapse/pull/19356
This commit is contained in:
Andrew Morgan
2026-01-07 16:31:55 +00:00
parent e660cf2cc4
commit d3045cd480
27 changed files with 171 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/usage/administration/admin_api/background_updates.md
+4 -2
View File
@@ -49,9 +49,11 @@ This API allows pausing background updates.
Background updates should *not* be paused for significant periods of time, as
this can affect the performance of Synapse.
*Note*: This won't persist over restarts.
> [!NOTE]
> This won't persist over restarts.
*Note*: This won't cancel any update query that is currently running. This is
> [!NOTE]
> This won't cancel any update query that is currently running. This is
usually fine since most queries are short lived, except for `CREATE INDEX`
background updates which won't be cancelled once started.
docs/usage/administration/admin_api/federation.md
+6 -4
View File
@@ -2,7 +2,8 @@
This API allows a server administrator to manage Synapse's federation with other homeservers.
Note: This API is new, experimental and "subject to change".
> [!NOTE]
> This API is new, experimental and "subject to change".
## List of destinations
@@ -62,9 +63,10 @@ The following query parameters are available:
- `dir` - Direction of room order. Either `f` for forwards or `b` for backwards. Setting
this value to `b` will reverse the above sort order. Defaults to `f`.
*Caution:* The database only has an index on the column `destination`.
This means that if a different sort order is used,
this can cause a large load on the database, especially for large environments.
> [!CAUTION]
> The database only has an index on the column `destination`.
> This means that if a different sort order is used,
> this can cause a large load on the database, especially for large environments.
**Response**
docs/usage/administration/admin_api/registration_tokens.md
+2 -1
View File
@@ -1,6 +1,7 @@
# Registration Tokens
**Note:** This API is disabled when MSC3861 is enabled. [See #15582](https://github.com/matrix-org/synapse/pull/15582)
> [!NOTE]
> This API is disabled when MSC3861 is enabled. [See #15582](https://github.com/matrix-org/synapse/pull/15582)
This API allows you to manage tokens which can be used to authenticate
registration requests, as proposed in