feat: Add permanent redirects for usage in vCluster Platform (#615)

Co-authored-by: Piotr Zaniewski <piotr.zaniewski@loft.sh>

Author: PRTTMPRPHT

netlify.toml

@@ -61,6 +61,188 @@ command = """
   from = "/docs/deploy/basics/*"
   to = "/docs/vcluster/deploy/basics/"
 
+### Permalinks for the platform UI.
+## The purpose of this is to keep the platform resilient against changes in the docs,
+## such that we can fix routing of docs links here, rather than requiring customers
+## to update to a new version.
+
+## CRDs
+
+# Project
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/crd/project"
+  to = "/docs/platform/api/resources/project"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/crd/project/:version"
+  to = "/docs/platform/:version/api/resources/project"
+
+# Team
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/crd/team"
+  to = "/docs/platform/api/resources/team"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/crd/team/:version"
+  to = "/docs/platform/:version/api/resources/team"
+
+# User
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/crd/user"
+  to = "/docs/platform/api/resources/user"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/crd/user/:version"
+  to = "/docs/platform/:version/api/resources/user"
+
+# Cluster Role Template
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/crd/clusterroletemplate"
+  to = "/docs/platform/api/resources/clusterroletemplate"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/crd/clusterroletemplate/:version"
+  to = "/docs/platform/:version/api/resources/clusterroletemplate"
+
+## Misc. platform links
+
+# OIDC tutorial
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/how-to-oidc-provider"
+  to = "/docs/platform/how-to/oidc-provider"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/how-to-oidc-provider/:version"
+  to = "/docs/platform/:version/how-to/oidc-provider"
+
+# Sleep mode tutorial
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/working-with-sleep-mode"
+  to = "/docs/platform/use-platform/virtual-clusters/key-features/sleep-mode#working-with-sleep-mode"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/working-with-sleep-mode/:version"
+  to = "/docs/platform/:version/use-platform/virtual-clusters/key-features/sleep-mode#working-with-sleep-mode"
+
+# Config
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/config"
+  to = "/docs/platform/configure/config"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/config/:version"
+  to = "/docs/platform/:version/configure/config"
+
+# Quick Start Guide / vCluster CLI
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/quick-start-quide"
+  to = "/docs/platform/install/quick-start-guide"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/quick-start-quide/:version"
+  to = "/docs/platform/:version/install/quick-start-guide"
+
+# karpenter integration
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/karpenter-integration"
+  to = "/docs/platform/integrations/karpenter"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/karpenter-integration/:version"
+  to = "/docs/platform/:version/integrations/karpenter"
+
+# Parameters
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/template-parameters"
+  to = "/docs/platform/administer/templates/advanced/parameters"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/template-parameters/:version"
+  to = "/docs/platform/:version/administer/templates/advanced/parameters"
+
+# Sleep Mode
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/sleep-mode"
+  to = "/docs/platform/use-platform/virtual-clusters/key-features/sleep-mode"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/sleep-mode/:version"
+  to = "/docs/platform/:version/use-platform/virtual-clusters/key-features/sleep-mode"
+
+# Connect cluster
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/connect-cluster"
+  to = "/docs/platform/administer/clusters/connect-cluster"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/connect-cluster/:version"
+  to = "/docs/platform/:version/administer/clusters/connect-cluster"
+
+# Project quotas
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/project-quotas"
+  to ="/docs/platform/administer/projects/quotas"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/project-quotas/:version"
+  to ="/docs/platform/:version/administer/projects/quotas"
+
+## Misc. vCluster links
+
+# Control Plane
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/control-plane"
+  to = "/docs/vcluster/category/components"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/platform/control-plane/:version"
+  to = "/docs/vcluster/:version/category/components"
+
+# Resource quota
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/resource-quota"
+  to = "/docs/vcluster/configure/vcluster-yaml/policies/resource-quota"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/resource-quota/:version"
+  to = "/docs/vcluster/:version/configure/vcluster-yaml/policies/resource-quota"
+
+# 0.20 migration
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/0-20-migration"
+  to = "/docs/vcluster/reference/migrations/0-20-migration"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/0-20-migration/:version"
+  to = "/docs/vcluster/:version0/reference/migrations/0-20-migration"
+
+# Sync from host
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/sync-from-host"
+  to = "/docs/vcluster/configure/vcluster-yaml/sync/from-host/"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/sync-from-host/:version"
+  to = "/docs/vcluster/:version/configure/vcluster-yaml/sync/from-host/"
+
+# Sync to host
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/sync-to-host"
+  to = "/docs/vcluster/configure/vcluster-yaml/sync/to-host/"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/sync-to-host/:version"
+  to = "/docs/vcluster/:version/configure/vcluster-yaml/sync/to-host/"
+
+# vcluster.yaml
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/vcluster-yaml"
+  to = "/docs/vcluster/configure/vcluster-yaml/"
+
+[[redirects]]
+  from = "/docs/platform-ui-link/vcluster/vcluster-yaml/:version"
+  to = "/docs/vcluster/:version/configure/vcluster-yaml/"
+
 [[redirects]]
   from = "/docs/vcluster/0.24.0/*"
   to = "/docs/vcluster/:splat"