Document how to do redirects & add redirects

Author: Tom-Willemsen

doc/Editing-the-Wiki.md

@@ -146,3 +146,11 @@ This is a tip!
 :::
 
 The list of supported admonitions is [on the MyST documentation](https://myst-parser.readthedocs.io/en/latest/syntax/admonitions.html).
+
+## Removing & deleting pages
+
+When moving pages, it is helpful to add redirects to the new location, so that links external to the wiki continue to
+work. To do this, we are using the [`sphinx-reredirects`](https://documatt.com/sphinx-reredirects/usage/) plugin.
+
+When moving a page, add a redirect from the old location to the new location. When deleting a page, add a redirect to
+the most suitable alternative documentation. The redirects are configured by the `redirects` key in `doc/conf.py`.

doc/client/compiling/Building-the-GUI.md

@@ -35,9 +35,10 @@ install_pre_commit_hook.bat
 
 You must use a version of eclipse which supports the RCP and Java versions currently in use by the client. There are
 two options for this:
-- Use the most recent version in `\\isis\inst$\Kits$\CompGroup\ICP\Developer Tools`
 - Download a recent Eclipse version directly from
 [the eclipse website](https://www.eclipse.org/downloads/packages/); choose the package for "RCP and RAP developers"
+- Use the most recent version in `\\isis\inst$\Kits$\CompGroup\ICP\Developer Tools` (which is simply a download from
+the Eclipse website, at a specific version).
 
 By convention eclipse versions are installed into `c:\tools`, for example in 
 `c:\tools\eclipse-rcp-2024-06-R-win32-x86_64`.

doc/client/eclipse/Common-Eclipse-Issues.md

@@ -139,3 +139,9 @@ to the `eclipse.exe` executable).
 If you see a `java.lang.UnsupportedClassVersionError` error at runtime, then:
 - Select Window -> Preferences -> Java -> Compiler
 - Set compliance level to 21.
+
+## Adding a dictionary to Eclipse's spelling checker
+
+- In Eclipse open `Window > Preferences > General > Editors > Text Editors > Spelling`
+- Change the "User defined dictionary" to `<ISIS Experiment Controls Shares>/Eclipse settings/code_dictionary.txt`
+

doc/client/eclipse/Common-Eclipse-Tasks.md

@@ -127,8 +127,7 @@ public class FooDisplay extends Canvas
 
 Instructions on adding a new perspective can be found [here](../coding/Adding-a-Button-to-the-Perspective-Switcher).
 
-Add A Preference Page
----------------------
+## Add A Preference Page
 
 Many plugins may have options that you want the user of the client to be able to configure. The simplest way to achieve this is to have the plugin contribute a preference page to the client's preference window.
 
@@ -296,7 +295,3 @@ The ``plugin.xml`` should now resemble:
 </plugin>
 ```
 The menu should now be visible in the client UI. For more details see the [Vogella menus tutorial](http://www.vogella.com/tutorials/EclipseCommands/article.html).
-
-## Add A Third Party Library To A Plugin
-
-To do

doc/client/eclipse/Creating-the-IBEX-Developer-Version-of-Eclipse.md

@@ -38,6 +38,8 @@
     "sphinx.ext.intersphinx",
     # Add links to source code in API docs
     "sphinx.ext.viewcode",
+    # Redirects
+    "sphinx_reredirects",
 ]
 napoleon_google_docstring = True
 napoleon_numpy_docstring = False
@@ -81,3 +83,10 @@
 spelling_warning = True
 spelling_show_suggestions = True
 spelling_suggestion_limit = 3
+
+redirects = {
+    "client/GUI-Getting-Started": "GUI-Building.html",
+    "client/eclipse/Creating-the-IBEX-Developer-Version-of-Eclipse": "../compiling/Building-the-GUI.html#gui-build-install-eclipse",  # noqa E501
+    "client/eclipse/Dictionary-setup": "Common-Eclipse-Issues.html#adding-a-dictionary-to-eclipse-s-spelling-checker",  # noqa E501
+    "client/getting_started/GUI-Development-Workflow": "../../processes/git_and_github/Git-workflow.html",  # noqa E501
+}

doc/client/eclipse/Dictionary-setup.md

@@ -30,6 +30,7 @@ dependencies = [
   "sphinx-autobuild",
   "linkify-it-py",
   "sphinxcontrib-spelling",
+  "sphinx-reredirects",
   "pytest",
 ]