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

Combine related admin API docs #8810

Closed

Description

@aaronraimist

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.

Activity

  1. added
    A-Docsthings relating to the documentation
    Z-Help-WantedWe know exactly how to fix this issue, and would be grateful for any contribution
    on Nov 25, 2020
  2. clokep commented on Nov 25, 2020

    @clokep
    Member

    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.

  3. linked a pull request that will close this issueCombine related media admin API docs #8839on Nov 30, 2020
  4. anoadragon453 commented on Dec 9, 2020

    @anoadragon453
    Member
  5. anoadragon453 commented on Dec 10, 2020

    @anoadragon453
    Member

    #8829 has now landed. Thanks @dklimpel!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-Docsthings relating to the documentationZ-Help-WantedWe know exactly how to fix this issue, and would be grateful for any contributionz-p3(Deprecated Label)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions