Fix some docs #7899

aaronraimist · 2020-07-18T22:49:29Z

Fixes #5536
Fixes #7782
Fixes #7076
Fixes #6609
Fixes #4413
Fixes #6545
Fixes #6528
Fixes #4672

Suggestions on how to reword for clarity are very welcome.

Pull Request Checklist

Pull request is based on the develop branch
Pull request includes a changelog file. 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.
Pull request includes a sign off
Code style is correct (run the linters)

Signed-off-by: Aaron Raimist <aaron@raim.ist>

…x-org#6545) Signed-off-by: Aaron Raimist <aaron@raim.ist>

…g#4672) Signed-off-by: Aaron Raimist <aaron@raim.ist>

Signed-off-by: Aaron Raimist <aaron@raim.ist>

richvdh · 2020-07-21T11:19:19Z

@clokep are there particular changes you are suggesting here?

clokep · 2020-07-21T11:22:22Z

@clokep are there particular changes you are suggesting here?

I guess I failed to write a comment. 🤦

@aaronraimist Can you update the sample config / make CI happy?

It is also generally easiest if separate fixes are done in separate PRs, although I imagine some of the documentation is intertwined.

Signed-off-by: Aaron Raimist <aaron@raim.ist>

aaronraimist · 2020-07-21T16:20:28Z

Done. Yeah just so you are aware we don't get emails or notifications that the CI failed so if you notice it has failed a comment would always be helpful.

The main reason I did it as one big PR is because it is annoying to do the newsfile dance 8 times in a row.

Signed-off-by: Aaron Raimist <aaron@raim.ist>

clokep

Looks pretty good! Thanks for taking a look at this. I left a few comments.

clokep · 2020-07-24T11:42:36Z

INSTALL.md

+## Client Well-known URI
+
+Setting up the client Well-Known URI is optional but if you set it up, it will
+allow users to enter their full username (e.g. `@user:server.com`) into clients


It would be nice if this example and below were consistent (e.g. I believe server.com and <server_name> should match?)

Yeah I just wasn’t sure how closely to match them. This is more like an example of a valid username (to compare to most people who think their username is just user or @user) whereas below is more like, fill this in with your server name, but maybe it would make sense to match them up.

I think making it as consistent as possible is good, but it isn't a huge deal.

Ok I changed this to @user:<server_name>

INSTALL.md

synapse/config/registration.py

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

Signed-off-by: Aaron Raimist <aaron@raim.ist>

clokep · 2020-07-29T14:06:01Z

@aaronraimist Thanks! Can you merge in develop to make CI happy? We added a check to CI, but it needed changes in the repo as well.

clokep · 2020-07-29T14:35:54Z

Thanks so much! 👍

richvdh · 2020-07-29T15:23:59Z

agreed, thanks so much for working through all this!

…bership_join_count * 'develop' of github.com:matrix-org/synapse: Update workers docs (#7990) Fix invite rejection when we have no forward-extremeties (#7980) Fix typo in docs/workers.md (#7992) Convert federation client to async/await. (#7975) Convert appservice to async. (#7973) Convert some of the data store to async. (#7976) Fix formatting of changelog and upgrade notes Ensure that remove_pusher is always async (#7981) Add deprecation warnings 1.18.0 Update worker docs with recent enhancements (#7969) Ensure the msg property of HttpResponseException is a string. (#7979) Remove from the event_relations table when purging historical events. (#7978) Add additional logging for SAML sessions. (#7971) Add MSC reference to changelog for #7736 Re-implement unread counts (#7736) Various improvements to the docs (#7899)

@lugino-emeritus

Synapse 1.19.0rc1 (2020-08-13) ============================== Removal warning --------------- As outlined in the [previous release](https://github.com/matrix-org/synapse/releases/tag/v1.18.0), we are no longer publishing Docker images with the `-py3` tag suffix. On top of that, we have also removed the `latest-py3` tag. Please see [the announcement in the upgrade notes for 1.18.0](https://github.com/matrix-org/synapse/blob/develop/UPGRADE.rst#upgrading-to-v1180). Features -------- - Add option to allow server admins to join rooms which fail complexity checks. Contributed by @lugino-emeritus. ([\#7902](#7902)) - Add an option to purge room or not with delete room admin endpoint (`POST /_synapse/admin/v1/rooms/<room_id>/delete`). Contributed by @dklimpel. ([\#7964](#7964)) - Add rate limiting to users joining rooms. ([\#8008](#8008)) - Add a `/health` endpoint to every configured HTTP listener that can be used as a health check endpoint by load balancers. ([\#8048](#8048)) - Allow login to be blocked based on the values of SAML attributes. ([\#8052](#8052)) - Allow guest access to the `GET /_matrix/client/r0/rooms/{room_id}/members` endpoint, according to MSC2689. Contributed by Awesome Technologies Innovationslabor GmbH. ([\#7314](#7314)) Bugfixes -------- - Fix a bug introduced in Synapse v1.7.2 which caused inaccurate membership counts in the room directory. ([\#7977](#7977)) - Fix a long standing bug: 'Duplicate key value violates unique constraint "event_relations_id"' when message retention is configured. ([\#7978](#7978)) - Fix "no create event in auth events" when trying to reject invitation after inviter leaves. Bug introduced in Synapse v1.10.0. ([\#7980](#7980)) - Fix various comments and minor discrepencies in server notices code. ([\#7996](#7996)) - Fix a long standing bug where HTTP HEAD requests resulted in a 400 error. ([\#7999](#7999)) - Fix a long-standing bug which caused two copies of some log lines to be written when synctl was used along with a MemoryHandler logger. ([\#8011](#8011), [\#8012](#8012)) Updates to the Docker image --------------------------- - We no longer publish Docker images with the `-py3` tag suffix, as [announced in the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/UPGRADE.rst#upgrading-to-v1180). ([\#8056](#8056)) Improved Documentation ---------------------- - Document how to set up a client .well-known file and fix several pieces of outdated documentation. ([\#7899](#7899)) - Improve workers docs. ([\#7990](#7990), [\#8000](#8000)) - Fix typo in `docs/workers.md`. ([\#7992](#7992)) - Add documentation for how to undo a room shutdown. ([\#7998](#7998), [\#8010](#8010)) Internal Changes ---------------- - Reduce the amount of whitespace in JSON stored and sent in responses. Contributed by David Vo. ([\#7372](#7372)) - Switch to the JSON implementation from the standard library and bump the minimum version of the canonicaljson library to 1.2.0. ([\#7936](#7936), [\#7979](#7979)) - Convert various parts of the codebase to async/await. ([\#7947](#7947), [\#7948](#7948), [\#7949](#7949), [\#7951](#7951), [\#7963](#7963), [\#7973](#7973), [\#7975](#7975), [\#7976](#7976), [\#7981](#7981), [\#7987](#7987), [\#7989](#7989), [\#8003](#8003), [\#8014](#8014), [\#8016](#8016), [\#8027](#8027), [\#8031](#8031), [\#8032](#8032), [\#8035](#8035), [\#8042](#8042), [\#8044](#8044), [\#8045](#8045), [\#8061](#8061), [\#8062](#8062), [\#8063](#8063), [\#8066](#8066), [\#8069](#8069), [\#8070](#8070)) - Move some database-related log lines from the default logger to the database/transaction loggers. ([\#7952](#7952)) - Add a script to detect source code files using non-unix line terminators. ([\#7965](#7965), [\#7970](#7970)) - Log the SAML session ID during creation. ([\#7971](#7971)) - Implement new experimental push rules for some users. ([\#7997](#7997)) - Remove redundant and unreliable signature check for v1 Identity Service lookup responses. ([\#8001](#8001)) - Improve the performance of the register endpoint. ([\#8009](#8009)) - Reduce less useful output in the newsfragment CI step. Add a link to the changelog section of the contributing guide on error. ([\#8024](#8024)) - Rename storage layer objects to be more sensible. ([\#8033](#8033)) - Change the default log config to reduce disk I/O and storage for new servers. ([\#8040](#8040)) - Add an assertion on `prev_events` in `create_new_client_event`. ([\#8041](#8041)) - Add a comment to `ServerContextFactory` about the use of `SSLv23_METHOD`. ([\#8043](#8043)) - Log `OPTIONS` requests at `DEBUG` rather than `INFO` level to reduce amount logged at `INFO`. ([\#8049](#8049)) - Reduce amount of outbound request logging at `INFO` level. ([\#8050](#8050)) - It is no longer necessary to explicitly define `filters` in the logging configuration. (Continuing to do so is redundant but harmless.) ([\#8051](#8051)) - Add and improve type hints. ([\#8058](#8058), [\#8064](#8064), [\#8060](#8060), [\#8067](#8067))

* commit '3950ae51e': Ensure that remove_pusher is always async (#7981) Ensure the msg property of HttpResponseException is a string. (#7979) Remove from the event_relations table when purging historical events. (#7978) Add additional logging for SAML sessions. (#7971) Add MSC reference to changelog for #7736 Re-implement unread counts (#7736) Various improvements to the docs (#7899) Convert storage layer to async/await. (#7963) Add an option to disable purge in delete room admin API (#7964) Move some log lines from default logger to sql/transaction loggers (#7952) Use the JSON module from the std library instead of simplejson. (#7936) Fix exit code for `check_line_terminators.sh` (#7970) Option to allow server admins to join complex rooms (#7902) Fix typo in metrics docs (#7966) Add script for finding files with unix line terminators (#7965) Convert the remaining media repo code to async / await. (#7947) Convert a synapse.events to async/await. (#7949) Convert groups and visibility code to async / await. (#7951) Convert push to async/await. (#7948)

aaronraimist added 9 commits July 18, 2020 16:47

Remove trusted_third_party_id_servers from new configs (matrix-org#5536)

86372a6

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Update password reset documentation (matrix-org#7782)

5a98362

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Various updates to README

237d2e8

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Remove hot spare language from README (matrix-org#7076)

6d435b5

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Document how to write time periods in homeserver.yaml (matrix-org#6609)

b9d8563

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Fix synctl.ronn (matrix-org#4413)

f9f7179

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Add disk space considerations to Postgres porting instructions (matri…

68e1d27

…x-org#6545) Signed-off-by: Aaron Raimist <aaron@raim.ist>

Attempt to document client Well-Known URI (matrix-org#6528, matrix-or…

d23094e

…g#4672) Signed-off-by: Aaron Raimist <aaron@raim.ist>

Add changelog

9f3f713

Signed-off-by: Aaron Raimist <aaron@raim.ist>

clokep added the X-Awaiting-Changes A contributed PR which needs changes and re-review before it can be merged label Jul 20, 2020

aaronraimist added 2 commits July 21, 2020 11:17

Add Debian changelog

3a15a66

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Amend changelog

6d911bb

Signed-off-by: Aaron Raimist <aaron@raim.ist>

aaronraimist added 2 commits July 21, 2020 11:23

Fix sample config generation

fd61afc

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Mention public_baseurl in client well-known setup

2e396b1

Signed-off-by: Aaron Raimist <aaron@raim.ist>

clokep removed the X-Awaiting-Changes A contributed PR which needs changes and re-review before it can be merged label Jul 23, 2020

clokep requested a review from a team July 23, 2020 21:14

clokep self-assigned this Jul 24, 2020

clokep suggested changes Jul 24, 2020

View reviewed changes

aaronraimist and others added 5 commits July 24, 2020 14:04

Update INSTALL.md

6670c10

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

Merge branch 'develop' into fix-docs

b104566

Merge branch 'fix-docs' of github.com:aaronraimist/synapse into fix-docs

ee78e19

Move information on PostgreSQL from README to INSTALL.md

0e25e86

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Update info on downstream Debian packages

fb4624b

Signed-off-by: Aaron Raimist <aaron@raim.ist>

aaronraimist requested a review from clokep July 26, 2020 14:49

aaronraimist added 3 commits July 26, 2020 18:59

Improve docs for downstream Debian and Ubuntu packages

e142115

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Typo

efc03d7

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Change username, hopefully this isn't confusing

880268a

Signed-off-by: Aaron Raimist <aaron@raim.ist>

Merge branch 'develop' into fix-docs

7dc673b

clokep approved these changes Jul 29, 2020

View reviewed changes

clokep merged commit 2184f61 into matrix-org:develop Jul 29, 2020

aaronraimist deleted the fix-docs branch July 29, 2020 14:38

aaronraimist mentioned this pull request Jul 29, 2020

Spell out that sqlite should only be used for initial experimentation #2889

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix some docs #7899

Fix some docs #7899

aaronraimist commented Jul 18, 2020 •

edited

Loading

richvdh commented Jul 21, 2020

clokep commented Jul 21, 2020

aaronraimist commented Jul 21, 2020

clokep left a comment

clokep Jul 24, 2020

aaronraimist Jul 24, 2020 •

edited

Loading

clokep Jul 29, 2020

aaronraimist Jul 29, 2020

clokep commented Jul 29, 2020

clokep commented Jul 29, 2020

richvdh commented Jul 29, 2020

Fix some docs #7899

Fix some docs #7899

Conversation

aaronraimist commented Jul 18, 2020 • edited Loading

Pull Request Checklist

richvdh commented Jul 21, 2020

clokep commented Jul 21, 2020

aaronraimist commented Jul 21, 2020

clokep left a comment

Choose a reason for hiding this comment

clokep Jul 24, 2020

Choose a reason for hiding this comment

aaronraimist Jul 24, 2020 • edited Loading

Choose a reason for hiding this comment

clokep Jul 29, 2020

Choose a reason for hiding this comment

aaronraimist Jul 29, 2020

Choose a reason for hiding this comment

clokep commented Jul 29, 2020

clokep commented Jul 29, 2020

richvdh commented Jul 29, 2020

aaronraimist commented Jul 18, 2020 •

edited

Loading

aaronraimist Jul 24, 2020 •

edited

Loading