From 97a6d689f7c6d76439e3f0d12d1de65ad379abb5 Mon Sep 17 00:00:00 2001
From: Zach Shilton <4624598+zchsh@users.noreply.github.com>
Date: Mon, 24 Oct 2022 15:46:26 -0400
Subject: [PATCH] website: reset redirects file (#12966)

* website: reset redirects file

* docs: add note on product prefix in redirects, with example
---
 website/redirects.js | 144 ++++++++-----------------------------------
 1 file changed, 26 insertions(+), 118 deletions(-)

diff --git a/website/redirects.js b/website/redirects.js
index c1c079373..4e063946f 100644
--- a/website/redirects.js
+++ b/website/redirects.js
@@ -1,122 +1,30 @@
-// REDIRECTS FILE
-
-// See the README file in this directory for documentation. Please do not
-// modify or delete existing redirects without first verifying internally.
-// Next.js redirect documentation: https://nextjs.org/docs/api-reference/next.config.js/redirects
-
-module.exports = [
-  { source: '/home', destination: '/', permanent: true },
-  { source: '/support', destination: '/', permanent: true },
-  { source: '/sponsors', destination: '/', permanent: true },
-  { source: '/about', destination: '/intro', permanent: true },
+/**
+ * Define your custom redirects within this file.
+ *
+ * See the README file in this directory for documentation. Please do not
+ * modify or delete existing redirects without first verifying internally.
+ *
+ * Vercel's redirect documentation:
+ * https://nextjs.org/docs/api-reference/next.config.js/redirects
+ *
+ * Relative paths with fragments (#) are not supported.
+ * For destinations with fragments, use an absolute URL.
+ *
+ * Playground for testing url pattern matching: https://npm.runkit.com/path-to-regexp
+ *
+ * Note that redirects defined in a product's redirects file are applied to
+ * the developer.hashicorp.com domain, which is where the documentation content
+ * is rendered. Redirect sources should be prefixed with the product slug
+ * to ensure they are scoped to the product's section. Any redirects that are
+ * not prefixed with a product slug will be ignored.
+ */
+ module.exports = [
+  /*
+  Example redirect:
   {
-    source: '/v1/:path*',
-    destination: 'https://docs-v1.vagrantup.com/:path*',
+    source: '/vagrant/docs/internal-docs/my-page',
+    destination: '/vagrant/docs/internals/my-page',
     permanent: true,
   },
-  {
-    source: '/blog/:path*',
-    destination: 'https://hashicorp.com/blog/:path*',
-    permanent: true,
-  },
-  {
-    source: '/download-archive/:path*',
-    destination: 'https://releases.hashicorp.com/vagrant',
-    permanent: true,
-  },
-  { source: '/intro/index', destination: '/intro', permanent: true },
-  { source: '/docs/index', destination: '/docs', permanent: true },
-  {
-    source: '/docs/virtualbox/:path*',
-    destination: '/docs/providers/virtualbox/:path*',
-    permanent: true,
-  },
-  {
-    source: '/docs/vmware/:path*',
-    destination: '/docs/providers/vmware/:path*',
-    permanent: true,
-  },
-  {
-    source: '/docs/docker/:path*',
-    destination: '/docs/providers/docker/:path*',
-    permanent: true,
-  },
-  {
-    source: '/docs/hyperv/:path*',
-    destination: '/docs/providers/hyperv/:path*',
-    permanent: true,
-  },
-  {
-    source: '/docs/vagrant-cloud',
-    destination: '/vagrant-cloud',
-    permanent: true,
-  },
-  {
-    source: '/docs/vagrant-cloud/:path*',
-    destination: '/vagrant-cloud/:path*',
-    permanent: true,
-  },
-  // Redirect "getting started" guides to Learn
-  {
-    source: '/(docs|intro)/getting-started',
-    destination:
-      'https://learn.hashicorp.com/collections/vagrant/getting-started',
-    permanent: true,
-  },
-  {
-    source: '/(docs|intro)/getting-started/project_setup',
-    destination:
-      'https://learn.hashicorp.com/tutorials/vagrant/getting-started-project-setup?in=vagrant/getting-started',
-    permanent: true,
-  },
-  {
-    source: '/(docs|intro)/getting-started/synced_folders',
-    destination:
-      'https://learn.hashicorp.com/tutorials/vagrant/getting-started-synced-folders?in=vagrant/getting-started',
-    permanent: true,
-  },
-  {
-    source: '/(docs|intro)/getting-started/:path*',
-    destination:
-      'https://learn.hashicorp.com/tutorials/vagrant/getting-started-:path*',
-    permanent: true,
-  },
-  {
-    source: '/docs/why-vagrant',
-    destination: '/intro#why-vagrant',
-    permanent: true,
-  },
-  {
-    source: '/boxes',
-    destination: 'https://app.vagrantup.com/boxes',
-    permanent: true,
-  },
-  {
-    source: '/boxes/search',
-    destination: 'https://app.vagrantup.com/boxes/search',
-    permanent: true,
-  },
-  {
-    source: '/downloads\\.(html?)?',
-    destination: '/downloads',
-    permanent: true,
-  },
-  {
-    source: '/download',
-    destination: '/downloads',
-    permanent: true,
-  },
-  {
-    source: '/vmware',
-    destination: '/docs/providers/vmware',
-    permanent: true,
-  },
-  {
-    source: '/vmware/reseller',
-    destination: '/docs/providers/vmware',
-    permanent: true,
-  },
-  // disallow '.html' or '/index.html' in favor of cleaner, simpler paths
-  { source: '/:path*/index', destination: '/:path*', permanent: true },
-  { source: '/:path*.html', destination: '/:path*', permanent: true },
+  */
 ]