diff --git a/docs/source/conf.py b/docs/source/conf.py index 4edb0cd5..4115e42a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -214,11 +214,28 @@ ogp_use_first_image = True # -- Options for the rediraffe extension ------------------------------------- # ref: https://github.com/wpilibsuite/sphinxext-rediraffe#readme # -# This extensions help us relocated content without breaking links. If a -# document is moved internally, a redirect like should be configured below to +# This extension helps us relocate content without breaking links. If a +# document is moved internally, a redirect link should be configured as below to # help us not break links. # -rediraffe_branch = "main" +# The workflow for adding redirects can be as follows: +# 1. Change "rediraffe_branch" below to point to the commit/ branch you +# want to make the changes based off. +# 2. Option 1: run "make rediraffecheckdiff" +# a. Analyze the output of this command +# b. Manually add the redirect entries to the "redirects.txt" file. +# Option 2: run "rediraffewritediff" +# a. rediraffe will then automatically add the obvious redirects to redirects.txt +# b. Analyze the output of the command for broken links. +# c. Check the "redirects.txt" file for any files that were moved/ renamed but are not listed. +# d. Manually add the redirects that havebeen mised by the automatic builder to "redirects.txt" +# Option 3: Do not use the commands above and, instead, do everything manually - by taking +# note of of the files you have moved or renamed and adding them to the "redirects.txt" file. +# +# If you are basing changes off another branch/ commit, always change back +# rediraffe_branch to main before pushing your changes upstream. +# +rediraffe_branch = "main" rediraffe_redirects = "redirects.txt" # rediraffe_redirects = { # "old-file": "new-folder/new-file-name", diff --git a/docs/source/redirects.txt b/docs/source/redirects.txt index b8cbd96c..e08f7090 100644 --- a/docs/source/redirects.txt +++ b/docs/source/redirects.txt @@ -6,3 +6,16 @@ "reference/proxy.md" "howto/proxy.md" "reference/templates.md" "howto/templates.md" "quickstart-docker.md" "tutorial/installation/quickstart-docker.md" +"reference/config-examples.md" "howto/index.md" +"getting-started/institutional-faq.md" "faq/institutional-faq.md" +"troubleshooting.md" "faq/troubleshooting.md" +"reference/config-sudo.md" "howto/configuration/config-sudo.md" +"reference/config-user-env.md" "howto/configuration/config-user-env.md" +"reference/rest.md" "howto/rest.md" +"reference/separate-proxy.md" "howto/separate-proxy.md" +"admin/upgrading.md" "howto/upgrading.md" +"installation-basics.md" "tutorial/installation/installation-basics.md" +"quickstart.md" "tutorial/installation/quickstart.md" + + +