docs: add internal redirects for moved or renamed pages (argoproj#12501)

Signed-off-by: Anton Gilgur <[email protected]>
AlbeeSo · Mar 9, 2024 · 158a981 · 158a981
1 parent 0a75598
commit 158a981
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 4 deletions.
diff --git a/docs/argo-server-sso.md b/docs/argo-server-sso.md
@@ -110,7 +110,7 @@ The precedence must be the lowest of all your service accounts.
 
 As of Kubernetes v1.24, secrets for a service account token are no longer automatically created.
 Therefore, service account secrets for SSO RBAC must be created manually.
-See [Manually create secrets](manually-create-secrets.md) for detailed instructions.
+See [Service Account Secrets](service-account-secrets.md) for detailed instructions.
 
 ## SSO RBAC Namespace Delegation
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
 mkdocs-material==8.2.6
+mkdocs-redirects==1.2.1
diff --git a/docs/manually-create-secrets.md → docs/service-account-secrets.md b/docs/manually-create-secrets.md → docs/service-account-secrets.md
diff --git a/docs/use-cases/webhdfs.md → docs/webhdfs.md b/docs/use-cases/webhdfs.md → docs/webhdfs.md
@@ -4,7 +4,7 @@
 
 ## Input Artifacts
 
-You can use [HTTP artifacts](../walk-through/hardwired-artifacts.md) to connect to webHDFS, where the URL will be the webHDFS endpoint including the file path and any query parameters.
+You can use [HTTP artifacts](walk-through/hardwired-artifacts.md) to connect to webHDFS, where the URL will be the webHDFS endpoint including the file path and any query parameters.
 Suppose your webHDFS endpoint is available under `https://mywebhdfsprovider.com/webhdfs/v1/` and you have a file `my-art.txt` located in a `data` folder, which you want to use as an input artifact. To construct the URL, you append the file path to the base webHDFS endpoint and set the [OPEN operation](https://hadoop.apache.org/docs/r3.3.3/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Open_and_Read_a_File) via query parameter. The result is: `https://mywebhdfsprovider.com/webhdfs/v1/data/my-art.txt?op=OPEN`.
 See the below Workflow which will download the specified webHDFS artifact into the specified `path`:
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -40,6 +40,12 @@ markdown_extensions:
           format: !!python/name:pymdownx.superfences.fence_code_format
   - toc:
       permalink: true
+plugins:
+  - redirects:
+      redirect_maps:
+        use-cases/webhdfs.md: webhdfs.md
+        manually-create-secrets.md: service-account-secrets.md
+  - search # re-include the default: https://www.mkdocs.org/user-guide/configuration/#plugins,
 validation:
   omitted_files: warn
   absolute_links: warn
@@ -131,6 +137,7 @@ nav:
           - workflow-of-workflows.md
           - workflow-notifications.md
           - work-avoidance.md
+          - webhdfs.md
       - UI Features:
           - artifact-visualization.md
           - widgets.md
@@ -164,7 +171,6 @@ nav:
           - use-cases/infrastructure-automation.md
           - use-cases/machine-learning.md
           - use-cases/stream-processing.md
-          - use-cases/webhdfs.md
           - use-cases/other.md # other should always be last
       - FAQ: faq.md
       - kubectl.md
@@ -242,7 +248,7 @@ nav:
           - workflow-executors.md
           - workflow-restrictions.md
           - sidecar-injection.md
-          - manually-create-secrets.md
+          - service-account-secrets.md
       - Argo Server:
           - argo-server.md
           - argo-server-auth-mode.md