From 158a981b890286ebdebe26ee43b2732ca6c614cd Mon Sep 17 00:00:00 2001 From: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Date: Sat, 9 Mar 2024 03:54:59 -0500 Subject: [PATCH] docs: add internal redirects for moved or renamed pages (#12501) Signed-off-by: Anton Gilgur --- docs/argo-server-sso.md | 2 +- docs/requirements.txt | 1 + ...ly-create-secrets.md => service-account-secrets.md} | 0 docs/{use-cases => }/webhdfs.md | 2 +- mkdocs.yml | 10 ++++++++-- 5 files changed, 11 insertions(+), 4 deletions(-) rename docs/{manually-create-secrets.md => service-account-secrets.md} (100%) rename docs/{use-cases => }/webhdfs.md (93%) diff --git a/docs/argo-server-sso.md b/docs/argo-server-sso.md index 524845a087fa..ec33829d55e1 100644 --- 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 index 4eab2e00983f..c8e43b02ec94 100644 --- 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 b/docs/service-account-secrets.md similarity index 100% rename from docs/manually-create-secrets.md rename to docs/service-account-secrets.md diff --git a/docs/use-cases/webhdfs.md b/docs/webhdfs.md similarity index 93% rename from docs/use-cases/webhdfs.md rename to docs/webhdfs.md index fe5f5061efc7..089f5fdb82b0 100644 --- a/docs/use-cases/webhdfs.md +++ b/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 index db5b269c22b9..fb79d3b356ea 100644 --- 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