chore(docs): redirect docs pages to new docs

argoproj · Oct 12, 2023 · 7c4dedc · 7c4dedc
1 parent de10506
commit 7c4dedc
Show file tree

Hide file tree

Showing 23 changed files with 169 additions and 0 deletions.
diff --git a/docs/Application-Deletion.md b/docs/Application-Deletion.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Application-Deletion/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Application-Deletion/). Redirecting to the new page.
+
+
 # Application Pruning & Resource Deletion
 
 All `Application` resources created by the ApplicationSet controller (from an ApplicationSet) will contain:

diff --git a/docs/Argo-CD-Integration.md b/docs/Argo-CD-Integration.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Argo-CD-Integration/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Argo-CD-Integration/). Redirecting to the new page.
+
+
 # How ApplicationSet controller interacts with Argo CD
 
 When you create, update, or delete an `ApplicationSet` resource, the ApplicationSet controller responds by creating, updating, or deleting one or more corresponding Argo CD `Application` resources.

diff --git a/docs/Controlling-Resource-Modification.md b/docs/Controlling-Resource-Modification.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Controlling-Resource-Modification/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Controlling-Resource-Modification/). Redirecting to the new page.
+
+
 # Controlling if/when the ApplicationSet controller modifies `Application` resources
 
 The ApplicationSet controller supports a number of settings that limit the ability of the controller to make changes to generated Applications, for example, preventing the controller from deleting child Applications.

diff --git a/docs/Development.md b/docs/Development.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Development/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Development/). Redirecting to the new page.
+
+
 # Development
 
 ## Running the ApplicationSet controller as an image within Kubernetes

diff --git a/docs/E2E-Tests.md b/docs/E2E-Tests.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/E2E-Tests/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/E2E-Tests/). Redirecting to the new page.
+
+
 # Running Application Set E2E tests
 
 The E2E tests will run automatically on each PR/commit as part of a GitHub action. You may also run these tests locally to verify the functionality, as described below.

diff --git a/docs/Generators-Cluster-Decision-Resource.md b/docs/Generators-Cluster-Decision-Resource.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Cluster-Decision-Resource/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Cluster-Decision-Resource/). Redirecting to the new page.
+
+
 # Cluster Decision Resource Generator
 
 The cluster decision resource generates a list of Argo CD clusters. This is done using [duck-typing](https://pkg.go.dev/knative.dev/pkg/apis/duck), which does not require knowledge of the full shape of the referenced kubernetes resource. The following is an example of a cluster-decision-resource-based ApplicationSet generator:

diff --git a/docs/Generators-Cluster.md b/docs/Generators-Cluster.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Cluster/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Cluster/). Redirecting to the new page.
+
+
 # Cluster Generator
 
 In Argo CD, managed clusters [are stored within Secrets](https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#clusters) in the Argo CD namespace. The ApplicationSet controller uses those same Secrets to generate parameters to identify and target available clusters.

diff --git a/docs/Generators-Git.md b/docs/Generators-Git.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Git/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Git/). Redirecting to the new page.
+
+
 # Git Generator
 
 The Git generator contains two subtypes: the Git directory generator, and Git file generator.

diff --git a/docs/Generators-List.md b/docs/Generators-List.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-List/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-List/). Redirecting to the new page.
+
+
 # List Generator
 
 The List generator generates parameters based on an arbitrary list of key/value pairs (as long as the values are string values). In this example, we're targeting a local cluster named `engineering-dev`:

diff --git a/docs/Generators-Matrix.md b/docs/Generators-Matrix.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Matrix/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Matrix/). Redirecting to the new page.
+
+
 # Matrix Generator
 
 The Matrix generator combines the parameters generated by two child generators, iterating through every combination of each generator's generated parameters. 

diff --git a/docs/Generators-Merge.md b/docs/Generators-Merge.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Merge/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Merge/). Redirecting to the new page.
+
+
 # Merge Generator
 
 The Merge generator combines parameters produced by the base (first) generator with matching parameter sets produced by subsequent generators. A _matching_ parameter set has the same values for the configured _merge keys_. _Non-matching_ parameter sets are discarded. Override precedence is bottom-to-top: the values from a matching parameter set produced by generator 3 will take precedence over the values from the corresponding parameter set produced by generator 2.

diff --git a/docs/Generators-Pull-Request.md b/docs/Generators-Pull-Request.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Pull-Request/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-Pull-Request/). Redirecting to the new page.
+
+
 # Pull Request Generator
 
 The Pull Request generator uses the API of an SCMaaS provider (eg GitHub/GitLab) to automatically discover open pull requests within an repository. This fits well with the style of building a test environment when you create a pull request.

diff --git a/docs/Generators-SCM-Provider.md b/docs/Generators-SCM-Provider.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-SCM-Provider/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators-SCM-Provider/). Redirecting to the new page.
+
+
 # SCM Provider Generator
 
 The SCM Provider generator uses the API of an SCMaaS provider (eg GitHub) to automatically discover repositories within an organization. This fits well with GitOps layout patterns that split microservices across many repositories.

diff --git a/docs/Generators.md b/docs/Generators.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Generators/). Redirecting to the new page.
+
+
 # Generators
 
 Generators are responsible for generating *parameters*, which are then rendered into the `template:` fields of the ApplicationSet resource. See the [Introduction](index.md) for an example of how generators work with templates, to create Argo CD Applications.

diff --git a/docs/Geting-Started.md b/docs/Geting-Started.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Geting-Started/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Geting-Started/). Redirecting to the new page.
+
+
 # Getting Started
 
 The Getting Started document has moved [here](Getting-Started.md).
diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Getting-Started/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Getting-Started/). Redirecting to the new page.
+
+
 # Getting Started
 
 This guide assumes you are familiar with Argo CD and its basic concepts. See the [Argo CD documentation](https://argo-cd.readthedocs.io/en/stable/core_concepts/) for more information.

diff --git a/docs/Release-Checklist-Template.md b/docs/Release-Checklist-Template.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Release-Checklist-Template/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Release-Checklist-Template/). Redirecting to the new page.
+
+
 
 # Release Checklist Template
 

diff --git a/docs/Releasing.md b/docs/Releasing.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Releasing/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Releasing/). Redirecting to the new page.
+
+
 # Releasing an ApplicationSet release
 
 The ApplicationSet controller release process and scripts are based on the process/scripts used by the [Argo CD Image Updater](https://github.com/argoproj-labs/argocd-image-updater), a sibling project in the Argo organization.

diff --git a/docs/Template.md b/docs/Template.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Template/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Template/). Redirecting to the new page.
+
+
 # Templates
 
 The template fields of the ApplicationSet `spec` are used to generate Argo CD `Application` resources.

diff --git a/docs/Use-Cases.md b/docs/Use-Cases.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Use-Cases/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/Use-Cases/). Redirecting to the new page.
+
+
 # Use cases supported by the ApplicationSet controller
 
 With the concept of generators, the ApplicationSet controller provides a powerful set of tools to automate the templating and modification of Argo CD Applications. Generators produce template parameter data from a variety of sources, including Argo CD clusters and Git repositories, supporting and enabling new use cases. 

diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/index/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/index/). Redirecting to the new page.
+
+
 # Introduction to ApplicationSet controller
 
 ## Introduction

diff --git a/docs/upgrading/v0.2.0-to-v0.3.0.md b/docs/upgrading/v0.2.0-to-v0.3.0.md
@@ -1,3 +1,9 @@
+<meta http-equiv="refresh" content="1; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/'" />
+
+!!! important "This page has moved"
+    This page has moved to [https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/upgrading/v0.2.0-to-v0.3.0/](https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/upgrading/v0.2.0-to-v0.3.0/). Redirecting to the new page.
+
+
 # Upgrading from ApplicationSet controller v0.2.0 to v0.3.0.
 
 When moving from ApplicationSet v0.2.0 to v0.3.0, there are a couple of behaviour changes to be aware of.

diff --git a/hack/set-docs-redirects.sh b/hack/set-docs-redirects.sh
@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+# ApplicationSet docs now live at https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/
+# This script adds redirects to the top of each ApplicationSet doc to redirect to the new location.
+
+set -e pipefail
+
+new_docs_base_path="https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/"
+new_docs_base_path_regex=$(echo "$new_docs_base_path" | sed 's/\//\\\//g')
+
+# Loop over files in the docs directory recursively. For each file, use sed to add the following redirect to the top:
+# <meta http-equiv="refresh" content="0; url='https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/{FILE PATH}'" />
+# FILE_PATH should be the path to the file relative to the docs directory, stripped of the .md extension.
+
+files=$(find docs -type f -name '*.md')
+for file in $files; do
+  file_path=$(echo "$file" | sed 's/^docs\///' | sed 's/\.md$/\//')
+  echo "Adding redirect to $file_path"
+  # If a redirect is already present at the top of the file, remove it.
+  sed '1s/<meta http-equiv="refresh" content="0; url='\''https:\/\/argo-cd.readthedocs.io\/en\/latest\/operator-manual\/applicationset\/.*'\'' \/>//' "$file" > "$file.tmp"
+  mv "$file.tmp" "$file"
+
+  # Add the new redirect.
+  # Default to an empty path.
+  file_path_regex=""
+  if curl -s -o /dev/null -w "%{http_code}" "$new_docs_base_path$file_path/" | grep -q 200; then
+    # If the destination path exists, use it.
+    file_path_regex=$(echo "$file_path" | sed 's/\//\\\//g')
+  fi
+
+  notice="!!! important \"This page has moved\"\n    This page has moved to [$new_docs_base_path$file_path]($new_docs_base_path$file_path). Redirecting to the new page.\n"
+
+  notice_regex=$(echo "$notice" | sed 's/\//\\\//g')
+
+  sed "1s/^/<meta http-equiv=\"refresh\" content=\"1; url='$new_docs_base_path_regex$file_path_regex'\" \/>\\n\\n$notice_regex\\n\\n/" "$file" > "$file.tmp"
+  mv "$file.tmp" "$file"
+done