Fix various typos in docs (#17114)

### Pull Request Checklist

<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->

* [X] Pull request is based on the develop branch
* [X] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
The entry should:
- Be a short description of your change which makes sense to users.
"Fixed a bug that prevented receiving messages from other servers."
instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
  - Use markdown where necessary, mostly for `code blocks`.
  - End with either a period (.) or an exclamation mark (!).
  - Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by
@github_username." or "Contributed by [Your Name]." to the end of the
entry.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
This commit is contained in:
devonh 2024-04-26 18:10:45 +00:00 committed by GitHub
parent 89fc579329
commit 0fd6b269d3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 13 additions and 12 deletions

1
changelog.d/17114.doc Normal file
View file

@ -0,0 +1 @@
Fix various small typos throughout the docs.

View file

@ -1,6 +1,6 @@
# Edit Room Membership API # Edit Room Membership API
This API allows an administrator to join an user account with a given `user_id` This API allows an administrator to join a user account with a given `user_id`
to a room with a given `room_id_or_alias`. You can only modify the membership of to a room with a given `room_id_or_alias`. You can only modify the membership of
local users. The server administrator must be in the room and have permission to local users. The server administrator must be in the room and have permission to
invite users. invite users.

View file

@ -51,8 +51,8 @@ clients.
## Server configuration ## Server configuration
Support for this feature can be enabled and configured by adding a the Support for this feature can be enabled and configured by adding the
`retention` in the Synapse configuration file (see `retention` option in the Synapse configuration file (see
[configuration manual](usage/configuration/config_documentation.md#retention)). [configuration manual](usage/configuration/config_documentation.md#retention)).
To enable support for message retention policies, set the setting To enable support for message retention policies, set the setting
@ -117,7 +117,7 @@ In this example, we define three jobs:
policy's `max_lifetime` is greater than a week. policy's `max_lifetime` is greater than a week.
Note that this example is tailored to show different configurations and Note that this example is tailored to show different configurations and
features slightly more jobs than it's probably necessary (in practice, a features slightly more jobs than is probably necessary (in practice, a
server admin would probably consider it better to replace the two last server admin would probably consider it better to replace the two last
jobs with one that runs once a day and handles rooms which jobs with one that runs once a day and handles rooms which
policy's `max_lifetime` is greater than 3 days). policy's `max_lifetime` is greater than 3 days).

View file

@ -128,7 +128,7 @@ can read more about that [here](https://www.postgresql.org/docs/10/kernel-resour
### Overview ### Overview
The script `synapse_port_db` allows porting an existing synapse server The script `synapse_port_db` allows porting an existing synapse server
backed by SQLite to using PostgreSQL. This is done in as a two phase backed by SQLite to using PostgreSQL. This is done as a two phase
process: process:
1. Copy the existing SQLite database to a separate location and run 1. Copy the existing SQLite database to a separate location and run

View file

@ -259,9 +259,9 @@ users, etc.) to the developers via the `--report-stats` argument.
This command will generate you a config file that you can then customise, but it will This command will generate you a config file that you can then customise, but it will
also generate a set of keys for you. These keys will allow your homeserver to also generate a set of keys for you. These keys will allow your homeserver to
identify itself to other homeserver, so don't lose or delete them. It would be identify itself to other homeservers, so don't lose or delete them. It would be
wise to back them up somewhere safe. (If, for whatever reason, you do need to wise to back them up somewhere safe. (If, for whatever reason, you do need to
change your homeserver's keys, you may find that other homeserver have the change your homeserver's keys, you may find that other homeservers have the
old key cached. If you update the signing key, you should change the name of the old key cached. If you update the signing key, you should change the name of the
key in the `<server name>.signing.key` file (the second word) to something key in the `<server name>.signing.key` file (the second word) to something
different. See the [spec](https://matrix.org/docs/spec/server_server/latest.html#retrieving-server-keys) for more information on key management). different. See the [spec](https://matrix.org/docs/spec/server_server/latest.html#retrieving-server-keys) for more information on key management).

View file

@ -44,7 +44,7 @@ For each update:
## Enabled ## Enabled
This API allow pausing background updates. This API allows pausing background updates.
Background updates should *not* be paused for significant periods of time, as Background updates should *not* be paused for significant periods of time, as
this can affect the performance of Synapse. this can affect the performance of Synapse.

View file

@ -241,7 +241,7 @@ in memory constrained environments, or increased if performance starts to
degrade. degrade.
However, degraded performance due to a low cache factor, common on However, degraded performance due to a low cache factor, common on
machines with slow disks, often leads to explosions in memory use due machines with slow disks, often leads to explosions in memory use due to
backlogged requests. In this case, reducing the cache factor will make backlogged requests. In this case, reducing the cache factor will make
things worse. Instead, try increasing it drastically. 2.0 is a good things worse. Instead, try increasing it drastically. 2.0 is a good
starting value. starting value.

View file

@ -86,9 +86,9 @@ The search term is then split into words:
* If unavailable, then runs of ASCII characters, numbers, underscores, and hyphens * If unavailable, then runs of ASCII characters, numbers, underscores, and hyphens
are considered words. are considered words.
The queries for PostgreSQL and SQLite are detailed below, by their overall goal The queries for PostgreSQL and SQLite are detailed below, but their overall goal
is to find matching users, preferring users who are "real" (e.g. not bots, is to find matching users, preferring users who are "real" (e.g. not bots,
not deactivated). It is assumed that real users will have an display name and not deactivated). It is assumed that real users will have a display name and
avatar set. avatar set.
### PostgreSQL ### PostgreSQL

View file

@ -634,7 +634,7 @@ worker application type.
#### Push Notifications #### Push Notifications
You can designate generic worker to sending push notifications to You can designate generic workers to send push notifications to
a [push gateway](https://spec.matrix.org/v1.5/push-gateway-api/) such as a [push gateway](https://spec.matrix.org/v1.5/push-gateway-api/) such as
[sygnal](https://github.com/matrix-org/sygnal) and email. [sygnal](https://github.com/matrix-org/sygnal) and email.