fix docs builder and redirect (#2092)

Signed-off-by: Fotis Nikolaidis <nikolaidis.fotis@gmail.com>
superduper-io · May 22, 2024 · 0487d23 · 0487d23
1 parent 04010cf
commit 0487d23
Show file tree

Hide file tree

Showing 7 changed files with 868 additions and 911 deletions.
diff --git a/Makefile b/Makefile
@@ -16,7 +16,7 @@ export SUPERDUPERDB_ARTIFACTS_DIR ?= ~/.cache/superduperdb/artifacts
 .DEFAULT_GOAL := help
 
 help: ## Display this help
-	@cat ./docs/api/banner.txt
+	@cat ./docs/static/banner.txt
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
 

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -102,6 +102,21 @@ const config = {
         },
       },
     ],
+    [
+      '@docusaurus/plugin-client-redirects',
+      {
+        createRedirects(existingPath) {
+          if (existingPath.includes('/docs')) {
+            // Redirect from /docs/docs/X to /docs/X
+            // This is to avoid broken links on existing sites that are pointing to superduper docs.
+            return [
+              existingPath.replace('/docs', '/docs/docs'),
+            ];
+          }
+          return undefined; // Return a falsy value: no redirect created
+        },
+      },
+    ],
   ],
   scripts: [
     {

diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
@@ -17,6 +17,7 @@
   "dependencies": {
     "@cmfcmf/docusaurus-search-local": "^1.1.0",
     "@docusaurus/core": "3.0.0",
+    "@docusaurus/plugin-client-redirects": "3.0.0",
     "@docusaurus/preset-classic": "3.0.0",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",

diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js
@@ -17,7 +17,7 @@ function HomepageHeader() {
         <div className={styles.buttons}>
           <Link
             className="button button--secondary button--lg"
-            to="/docs/docs/intro"
+            to="docs/intro"
           >
             Read documentation
           </Link>

diff --git a/docs/static/banner.txt b/docs/static/banner.txt
@@ -0,0 +1,10 @@
+****************************************************************************
+    _____                       _____                        _____  ____
+   / ____|                     |  __ \                      |  __ \|  _ \
+  | (___  _   _ _ __   ___ _ __| |  | |_   _ _ __   ___ _ __| |  | | |_) |
+   \___ \| | | | '_ \ / _ \ '__| |  | | | | | '_ \ / _ \ '__| |  | |  _ <
+   ____) | |_| | |_) |  __/ |  | |__| | |_| | |_) |  __/ |  | |__| | |_) |
+  |_____/ \__,_| .__/ \___|_|  |_____/ \__,_| .__/ \___|_|  |_____/|____/
+               | |                          | |
+               |_|                          |_|
+****************************************************************************
diff --git a/docs/static/index.html b/docs/static/index.html
@@ -4,15 +4,15 @@
     <meta charset="UTF-8" />
     <meta
       http-equiv="refresh"
-      content="0; url=docs/docs/intro"
+      content="0; url=docs/intro"
     />
     <script type="text/javascript">
-      window.location.href = 'docs/docs/intro';
+      window.location.href = 'docs/intro';
     </script>
     <title>Your Site Title Here</title>
   </head>
   <body>
     If you are not redirected automatically, follow this
-    <a href="docs/docs/intro">link</a>.
+    <a href="docs/intro">link</a>.
   </body>
 </html>