Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

List removed community/group worker endpoints in upgrade.md #13020

Closed
olmari opened this issue Jun 10, 2022 · 4 comments · Fixed by #13023
Closed

List removed community/group worker endpoints in upgrade.md #13020

olmari opened this issue Jun 10, 2022 · 4 comments · Fixed by #13023
Labels
A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements.

Comments

@olmari
Copy link
Contributor

olmari commented Jun 10, 2022

I'd expect to see community worker endpoints that are going to be nuked in Synapse 1.61 ( https://github.com/matrix-org/synapse/pull/12936/files#diff-4eef4606c1f655c8f2b04944a322717d2dfe2a32f6df6df8403dad7ebdd00052 ) to be listed in Synapse upgrade notes at release time.

Reasoning: It is easy to check current state of existing endpoints from workers.md, but opposite is not true, surprisingly hard to determine does one have an endpoint in their config that is not listed on workers.md anymore. So at least upgrade notes should reveal "these endpoints are removed, go check your worker config".

@olmari
Copy link
Contributor Author

olmari commented Jun 10, 2022

Alternate/adjacent idea was to have some kind of "historical endpoints" section on workers.md. While nice idea in itself especially for not so pedantically up to date keeping server admin, I feel upgrade notes is exactly proper place to tell which (worker) endpoints going EOL.

@clokep
Copy link
Member

clokep commented Jun 10, 2022

Would you be willing to make a PR including this information?

@olmari
Copy link
Contributor Author

olmari commented Jun 10, 2022

Well I can easily copypaste the endpoints, I can do that and Wrote description and base for next upgrade.md, I'll leave making doc looking proper to devs :)

@DMRobertson DMRobertson linked a pull request Jun 10, 2022 that will close this issue
4 tasks
@reivilibre reivilibre added T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements. A-Docs things relating to the documentation labels Jun 13, 2022
@clokep
Copy link
Member

clokep commented Jun 14, 2022

Related to #11584.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants