fixup: add redirects for pages renamed in #2808

changelog.d/4-docs/sphinx-redirect

@@ -0,0 +1 @@
+Add extension sphinx-reredirects and configuration to generate simple JavaScript based redirects to new locations of previously inconsistently named files/URLs.

docs/src/conf.py

@@ -44,7 +44,8 @@
     'sphinxcontrib.kroki',
     "myst_parser",
     'rst2pdf.pdfbuilder',
-    'sphinx_multiversion'
+    'sphinx_multiversion',
+    'sphinx_reredirects',
 ]
 
 # Grouping the document tree into PDF files. List of tuples
@@ -122,3 +123,11 @@
 
 # As per https://myst-parser.readthedocs.io/en/latest/syntax/optional.html?highlight=anchor#auto-generated-header-anchors
 myst_heading_anchors = 4
+
+redirects = {
+        "security-responses/log4shell": "2021-12-15_log4shell.html",
+        "security-responses/cve-2021-44521": "2022-02-21_cve-2021-44521.html",
+        "security-responses/2022-05_website_outage": "2022-05-23_website_outage.html",
+        "how-to/single-sign-on/index": "../../understand/single-sign-on/main.html#setting-up-sso-externally",
+        "how-to/scim/index": "../../understand/single-sign-on/main.html#user-provisioning",
+}

docs/src/index.rst

@@ -26,9 +26,7 @@ This documentation may be expanded in the future to cover other aspects of Wire.
    Release notes <release-notes.rst>
    Administrator's Guide <how-to/index.rst>
    Understanding wire-server components <understand/index.rst>
-   Single-sign-on how-tos <how-to/single-sign-on/index.rst>
    Administrator's manual: single-sign-on and user provisioning <understand/single-sign-on/main.rst>
-   How to set up user provisioning with LDAP or SCIM <how-to/scim/index.rst>
    Client API documentation <understand/api-client-perspective/index.rst>
    Security responses <security-responses/index.rst>
    Notes for developers <developer/index.rst>

nix/default.nix

@@ -33,6 +33,7 @@ let
         sphinx-autobuild
         sphinx-multiversion
         sphinx_rtd_theme
+        sphinx_reredirects
         sphinxcontrib-fulltoc
         sphinxcontrib-kroki
       ]))

nix/overlay-docs.nix

@@ -3,6 +3,7 @@ self: super: rec {
     packageOverrides = pself: psuper: {
       rst2pdf = pself.callPackage ./pkgs/python-docs/rst2pdf.nix { };
       sphinx-multiversion = pself.callPackage ./pkgs/python-docs/sphinx-multiversion.nix { };
+      sphinx_reredirects = pself.callPackage ./pkgs/python-docs/sphinx_reredirects.nix { };
       sphinxcontrib-kroki = pself.callPackage ./pkgs/python-docs/sphinxcontrib-kroki.nix { };
       svg2rlg = pself.callPackage ./pkgs/python-docs/svg2rlg.nix { };
     };

nix/pkgs/python-docs/sphinx_reredirects.nix

@@ -0,0 +1,20 @@
+{
+  fetchPypi,
+  buildPythonPackage,
+
+  sphinx,
+} :
+buildPythonPackage rec {
+
+  pname = "sphinx_reredirects";
+  version = "0.1.1";
+  src = fetchPypi {
+    inherit pname version;
+    sha256 = "sha256:RRmkXTFskhxGMnty/kEOHnoy/lFpR0EpYCCwygCPvO4=";
+  };
+
+  propagatedBuildInputs = [
+    sphinx
+  ];
+
+}