Add Rediraffe support

contributing/submit-contribution.rst

@@ -29,7 +29,26 @@ You can run:
    make linkcheck
 
 To perform a full spelling and link check. You can also run ``make`` by itself
-to see a list of all the possible ``make`` targets. 
+to see a list of all the possible ``make`` targets.
+
+Check if you need redirects
+===========================
+
+If you rename, move or delete an existing file, a corresponding redirect must
+be created to ensure users don't run into 404 errors in the published
+documentation.
+
+To set up a redirect, add a line to the end of the `redirects.txt` file in the
+root directory, in the following format:
+
+```
+redirect/path/from/ redirect/path/to/
+```
+
+Note that there should be no preceding foward slash at the start of the path,
+but there must be a trailing one at the end. See the
+`Sphinx Rediraffe docs <https://sphinxext-rediraffe.readthedocs.io/en/latest/>`_
+for more guidance, or reach out to us for help.
 
 Manual testing
 ==============

custom_conf.py

@@ -167,6 +167,7 @@
     'myst_parser',
     'sphinxcontrib.jquery',
     'sphinxcontrib.mermaid',
+    'sphinxext.rediraffe',
 #    'canonical.youtube-links',
 #    'canonical.related-links',
 #    'canonical.custom-rst-roles',
@@ -183,8 +184,13 @@
 # sphinxext-opengraph
 custom_required_modules = [
     'sphinxcontrib-mermaid',
+    'sphinxext-rediraffe',
 ]
 
+# Add redirects, so they can be updated here to land with docs being moved
+rediraffe_branch = "main"
+rediraffe_redirects = "redirects.txt"
+
 # Add files or directories that should be excluded from processing.
 custom_excludes = [
     'cheatsheets/',

redirects.txt

@@ -0,0 +1,9 @@
+# Comment lines start with a hash (#) and are ignored
+# Each redirect should appear on its own line
+# Do not include a file extension
+# Paths don't need a slash in front of them
+# We are using the dirhtml builder so we need a trailing slash at the end
+# The paths should match what's in the build directory
+# Example:
+# redirect/from redirect/to
+