diff --git a/changelog.d/4-docs/sphinx-redirect b/changelog.d/4-docs/sphinx-redirect new file mode 100644 index 0000000000..60b9a22e11 --- /dev/null +++ b/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. diff --git a/docs/src/conf.py b/docs/src/conf.py index f087fbc877..e7c36d04e6 100644 --- a/docs/src/conf.py +++ b/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", +} diff --git a/docs/src/how-to/scim/index.rst b/docs/src/how-to/scim/index.rst deleted file mode 100644 index e3bdf6419d..0000000000 --- a/docs/src/how-to/scim/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -How to set up user provisioning with LDAP or SCIM -================================================= - -This page has moved to :ref:`User provisioning`. diff --git a/docs/src/how-to/single-sign-on/index.rst b/docs/src/how-to/single-sign-on/index.rst deleted file mode 100644 index f4aaba257f..0000000000 --- a/docs/src/how-to/single-sign-on/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -Single-sign-on how-tos -====================== - -This page moved to :ref:`Setting up SSO externally`. diff --git a/docs/src/index.rst b/docs/src/index.rst index a45427919b..28721d822a 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -26,9 +26,7 @@ This documentation may be expanded in the future to cover other aspects of Wire. Release notes Administrator's Guide Understanding wire-server components - Single-sign-on how-tos Administrator's manual: single-sign-on and user provisioning - How to set up user provisioning with LDAP or SCIM Client API documentation Security responses Notes for developers diff --git a/nix/default.nix b/nix/default.nix index 9c134b5c13..11ed4ac483 100644 --- a/nix/default.nix +++ b/nix/default.nix @@ -33,6 +33,7 @@ let sphinx-autobuild sphinx-multiversion sphinx_rtd_theme + sphinx_reredirects sphinxcontrib-fulltoc sphinxcontrib-kroki ])) diff --git a/nix/overlay-docs.nix b/nix/overlay-docs.nix index 0eb09c95cb..5175ccbe77 100644 --- a/nix/overlay-docs.nix +++ b/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 { }; }; diff --git a/nix/pkgs/python-docs/sphinx_reredirects.nix b/nix/pkgs/python-docs/sphinx_reredirects.nix new file mode 100644 index 0000000000..2985a9d775 --- /dev/null +++ b/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 + ]; + +}