This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Combine related admin API docs #8810
Labels
A-Docs
things relating to the documentation
Z-Help-Wanted
We know exactly how to fix this issue, and would be grateful for any contribution
z-p3
(Deprecated Label)
Comments
clokep
added
A-Docs
things relating to the documentation
Z-Help-Wanted
We know exactly how to fix this issue, and would be grateful for any contribution
labels
Nov 25, 2020
Agreed! Would really appreciate someone taking a once over of those and seeing how they could be better organized. Some of them (e.g. the rooms.md file) could use a table of contents at the top -- similar to the user_admin_api.md. |
This was referenced Nov 26, 2020
4 tasks
anoadragon453
pushed a commit
that referenced
this issue
Dec 9, 2020
Related: #8810 Also a few small improvements. Signed-off-by: Dirk Klimpel [email protected]
This is still to be done, and will be once #8829 lands. |
anoadragon453
pushed a commit
that referenced
this issue
Dec 10, 2020
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
Z-Help-Wanted
We know exactly how to fix this issue, and would be grateful for any contribution
z-p3
(Deprecated Label)
Currently there is a separate file for the purge remote media API docs and the rest of the media APIs
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/purge_remote_media.rst
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/media_admin_api.md
There is also separate files for the purge room API, shutdown room API, and then the rest of the room APIs
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/purge_room.md
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/shutdown_room.md
https://github.com/matrix-org/synapse/blob/master/docs/admin_api/rooms.md
It probably makes sense for all of the media APIs to be in one file and all of the room APIs to be in another, rather than being spread out like this.
The text was updated successfully, but these errors were encountered: