From 717d1ee2fa9db2cef19093a2e67f6a508f58f901 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 23 Jun 2021 16:03:25 +0100 Subject: [PATCH 1/2] Choose an index.html when generating a docs build --- .github/workflows/docs.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 23b8d7f9093e..c239130c576b 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -23,7 +23,12 @@ jobs: mdbook-version: '0.4.9' - name: Build the documentation - run: mdbook build + # mdbook will only create an index.html if we're including docs/README.md in SUMMARY.md. + # However, we're using docs/README.md for other purposes and need to pick a new page + # as the default. Let's opt for the welcome page instead. + run: | + mdbook build + cp book/welcome_and_overview.html book/index.html # Deploy to the latest documentation directories - name: Deploy latest documentation From dbe43b3c498a5b8493ca3a05653ad623e5da9779 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 23 Jun 2021 16:29:06 +0100 Subject: [PATCH 2/2] Changelog --- changelog.d/10242.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/10242.doc diff --git a/changelog.d/10242.doc b/changelog.d/10242.doc new file mode 100644 index 000000000000..2241b285474f --- /dev/null +++ b/changelog.d/10242.doc @@ -0,0 +1 @@ +Choose Welcome & Overview as the default page for synapse documentation website.