synapse/docs/admin_api
Andrew Morgan c141455049
Docs: Use something other than the document name to describe a page (#10399)
Our documentation has a history of using a document's name as a way to link to it, such as "See [workers.md]() for details". This makes sense when you're traversing a directory of files, but less sense when the files are abstracted away - as they are on the documentation website.

This PR changes the links to various documentation pages to something that fits better into the surrounding sentence, as you would when making any hyperlink on the web.
2021-07-15 12:47:55 +01:00
..
README.rst Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
account_validity.md Convert admin api docs to markdown (#10089) 2021-06-03 14:06:03 +01:00
delete_group.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
event_reports.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
media_admin_api.md Fix a broken link in the admin api docs (#10322) 2021-07-07 12:54:57 +01:00
purge_history_api.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
purge_room.md Deprecate Shutdown Room and Purge Room Admin API (#8829) 2020-12-10 11:42:48 +00:00
register_api.md Convert admin api docs to markdown (#10089) 2021-06-03 14:06:03 +01:00
room_membership.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
rooms.md Simplify structure of room admin API docs (#10313) 2021-07-07 12:18:36 +01:00
server_notices.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
shutdown_room.md Deprecate Shutdown Room and Purge Room Admin API (#8829) 2020-12-10 11:42:48 +00:00
statistics.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
user_admin_api.md Add SSO `external_ids` to Query User Account admin API (#10261) 2021-07-01 11:26:24 +02:00
version_api.md Convert admin api docs to markdown (#10089) 2021-06-03 14:06:03 +01:00

README.rst

Admin APIs
==========

**Note**: The latest documentation can be viewed `here <https://matrix-org.github.io/synapse>`_.
See `docs/README.md <../README.md>`_ for more information.

**Please update links to point to the website instead.** Existing files in this directory
are preserved to maintain historical links, but may be moved in the future.

This directory includes documentation for the various synapse specific admin
APIs available. Updates to the existing Admin API documentation should still
be made to these files, but any new documentation files should instead be placed under
`docs/usage/administration/admin_api <../usage/administration/admin_api>`_.