summary refs log tree commit diff
path: root/README.rst
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2021-06-23 16:57:57 +0100
committerGitHub <noreply@github.com>2021-06-23 16:57:57 +0100
commit7f25d7385909ace3a84ee621f014d56734fecd44 (patch)
treef11e0739923348c6ee0e818614c5118251b2c005 /README.rst
parentFixes to the release script (#10239) (diff)
downloadsynapse-7f25d7385909ace3a84ee621f014d56734fecd44.tar.xz
Convert UPGRADE.rst to markdown (#10166)
This PR:

* Converts UPGRADE.rst to markdown and moves the contents into the `docs/` directory.
* Updates the contents of UPGRADE.rst to point to the website instead.
* Updates links around the codebase that point to UPGRADE.rst.

`pandoc` + some manual editing was used to convert from RST to md.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.rst b/README.rst

index 2ecc93c8a7..1244aab10b 100644 --- a/README.rst +++ b/README.rst
@@ -186,11 +186,11 @@ impact to other applications will be minimal. Upgrading an existing Synapse ============================= -The instructions for upgrading synapse are in `UPGRADE.rst`_. +The instructions for upgrading synapse are in `the upgrade notes`_. Please check these instructions as upgrading may require extra steps for some versions of synapse. -.. _UPGRADE.rst: UPGRADE.rst +.. _the upgrade notes: https://matrix-org.github.io/synapse/develop/upgrade.html .. _reverse-proxy: