0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-11-14 22:11:47 +01:00
synapse/changelog.d
Andrew Morgan f0e02f5df2
Create an index.html file when generating a docs build (#10242)
Currently when a new build of the docs is created, an `index.html` file does not exist. Typically this would be generated from a`docs/README.md` file - which we have - however we're currently using [docs/README.md](394673055d/docs/README.md) to explain the docs and point to the website. It is not part of the content of the website. So we end up not having an `index.html` file, which will result in a 404 page if one tries to navigate to `https://matrix-org.github.io/synapse/<docs_version>/index.html`.

This isn't a really problem for the default version of the documentation (currently `develop`), as [navigating to the top-level root](https://matrix-org.github.io/synapse/) of the website (without specifying a version) will [redirect](a77e6925f2/index.html (L2)) you to the Welcome and Overview page of the `develop` docs version.

However, ideally once we add a GUI for switching between versions, we'll want to send the user to `matrix-org.github.io/synapse/<version>/index.html`, which currently isn't generated.

This PR modifies the CI that builds the docs to simply copy the rendered [Welcome & Overview page](https://matrix-org.github.io/synapse/develop/welcome_and_overview.html) to `index.html`.
2021-06-24 18:00:56 +01:00
..
.gitignore Correct attrs package name in requirements (#3492) 2018-07-07 10:46:59 +10:00
9450.feature MSC2918 Refresh tokens implementation (#9450) 2021-06-24 14:33:20 +01:00
10114.misc Drop Origin & Accept from Access-Control-Allow-Headers value (#10114) 2021-06-23 11:25:03 +01:00
10166.doc Convert UPGRADE.rst to markdown (#10166) 2021-06-23 16:57:57 +01:00
10214.feature Re-introduce "Leave out optional keys from /sync" change (#10214) 2021-06-23 15:57:41 +01:00
10223.bugfix Send out invite rejections and knocks over federation (#10223) 2021-06-23 12:54:50 +01:00
10225.feature Improve validation for send_{join,leave,knock} (#10225) 2021-06-24 15:30:49 +01:00
10237.misc Improve the reliability of auto-joining remote rooms (#10237) 2021-06-23 16:14:52 +02:00
10239.misc Fixes to the release script (#10239) 2021-06-23 17:55:26 +02:00
10242.doc Create an index.html file when generating a docs build (#10242) 2021-06-24 18:00:56 +01:00
10243.feature Return errors from send_join etc if the event is rejected (#10243) 2021-06-24 16:00:08 +01:00