synapse/changelog.d/10242.doc at aaf7d1acb8804ddeeb007e21c2b2c915bd494898 - mirrors/synapse - Sadium Git

mirrors/synapse

mirror of https://github.com/element-hq/synapse.git synced 2024-11-24 02:25:45 +03:00

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

1 line

81 B

Text

Raw Blame History

Choose Welcome & Overview as the default page for synapse documentation website.