feat: Docset archiving

archivedVersions.json

@@ -0,0 +1,6 @@
+{
+    "enterprise-24.2": "https://docs.seqera.io/platform-enterprise/24.2",
+    "enterprise-24.1": "https://docs.seqera.io/platform-enterprise/24.1",
+    "enterprise-23.4": "https://docs.seqera.io/platform-enterprise/23.4",
+    "enterprise-23.3": "https://docs.seqera.io/platform-enterprise/23.3"
+}

docusaurus.config.js

@@ -3,7 +3,6 @@ const path = require("path");
 import "dotenv/config";
 import platform_enterprise_latest_version from "./platform-enterprise_latest_version.js";
 
-
 export default async function createConfigAsync() {
   const changelog = {
     blogTitle: "Seqera Changelog",
@@ -21,7 +20,7 @@ export default async function createConfigAsync() {
       description: "Stay updated with our blog posts!",
       copyright: `Copyright © ${new Date().getFullYear()} Seqera`,
     },
-    onUntruncatedBlogPosts: 'ignore',
+    onUntruncatedBlogPosts: "ignore",
   };
 
   const docs_platform_enterprise = [
@@ -30,7 +29,7 @@ export default async function createConfigAsync() {
       id: "platform-enterprise",
       routeBasePath: "/platform-enterprise",
       path: "platform-enterprise_docs",
-      // For PR Previews we want to see the latest doc-set with expected changes. 
+      // For PR Previews we want to see the latest doc-set with expected changes.
       includeCurrentVersion: process.env.INCLUDE_NEXT ? true : false,
       lastVersion: platform_enterprise_latest_version,
       remarkPlugins: [
@@ -44,7 +43,6 @@ export default async function createConfigAsync() {
       sidebarPath: "platform-enterprise_docs/enterprise-sidebar.json",
     },
   ];
-
 
   const docs_platform_api = [
     "@docusaurus/plugin-content-docs",
@@ -178,25 +176,25 @@ export default async function createConfigAsync() {
     trailingSlash: false,
 
     /*
-    * Enable faster Docusaurus optimizations (experimental v4 features)
-    * Reference: https://github.com/facebook/docusaurus/issues/10556
-    * 
-    * WARNING: swcJsMinimizer & lightningCssMinimizer are disabled due to memory issues
-    * - Cause excessive memory usage leading to build failures
-    * - The believe is that our 22k of OpenAPI docs causes this issue due to the way they are generated.
-    * - See: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/1025
-    * 
-    * These optimizations may require additional configuration when memory issues are resolved.
-    */
-   future: {
+     * Enable faster Docusaurus optimizations (experimental v4 features)
+     * Reference: https://github.com/facebook/docusaurus/issues/10556
+     *
+     * WARNING: swcJsMinimizer & lightningCssMinimizer are disabled due to memory issues
+     * - Cause excessive memory usage leading to build failures
+     * - The believe is that our 22k of OpenAPI docs causes this issue due to the way they are generated.
+     * - See: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/1025
+     *
+     * These optimizations may require additional configuration when memory issues are resolved.
+     */
+    future: {
       v4: true,
       experimental_faster: {
-        swcJsLoader: false,
-        swcJsMinimizer: false,
-        swcHtmlMinimizer: false,
-        lightningCssMinimizer: false,
+        swcJsLoader: true,
+        swcJsMinimizer: true,
+        swcHtmlMinimizer: true,
+        lightningCssMinimizer: true,
         rspackBundler: true,
-        mdxCrossCompilerCache: false,
+        mdxCrossCompilerCache: true,
       },
     },
 
@@ -205,9 +203,12 @@ export default async function createConfigAsync() {
     organizationName: "seqeralabs", // Usually your GitHub org/user name.
     projectName: "docs", // Usually your repo name.
 
-    onBrokenLinks: process.env.FAIL_ON_BROKEN_LINKS === "true" ? "throw" : "warn",
-    onBrokenMarkdownLinks: process.env.FAIL_ON_BROKEN_LINKS === "true" ? "throw" : "warn",
-    onBrokenAnchors: process.env.FAIL_ON_BROKEN_LINKS === "true" ? "throw" : "warn",
+    onBrokenLinks:
+      process.env.FAIL_ON_BROKEN_LINKS === "true" ? "throw" : "warn",
+    onBrokenMarkdownLinks:
+      process.env.FAIL_ON_BROKEN_LINKS === "true" ? "throw" : "warn",
+    onBrokenAnchors:
+      process.env.FAIL_ON_BROKEN_LINKS === "true" ? "throw" : "warn",
 
     customFields: {
       // Put your custom environment here
@@ -283,8 +284,7 @@ export default async function createConfigAsync() {
         return {
           name: "docusaurus-tailwindcss",
           configurePostCss(postcssOptions) {
-            postcssOptions.plugins.push(require("tailwindcss"));
-            postcssOptions.plugins.push(require("autoprefixer"));
+            postcssOptions.plugins = [require("@tailwindcss/postcss")];
             return postcssOptions;
           },
         };
@@ -299,26 +299,22 @@ export default async function createConfigAsync() {
           src: "img/Logo.svg",
           srcDark: "img/LogoWhite.svg",
           width: "180px",
-          className: 'w-[100px]'
+          height: "40px",
+          style: {
+            width: "180px",
+            height: "40px"
+          }
         },
         items: [
-           // Note: This workaround was added to resolve pages from 404ing when navigating away from platform-api paths, due to separate build implementation. 
-           // TODO: Revert urls once we have docs in a single build
           {
-            // to: "/platform-cloud/",
-            // position: "left",
-            // label: "Platform Cloud",
-            type: 'html',
-            position: 'left',
-            value: '<a href="https://docs.seqera.io/platform-cloud/" class="menu__link">Platform Cloud</a>'
+            to: "/platform-cloud",
+            position: "left",
+            label: "Platform Cloud",
           },
           {
-            // to: "/platform-enterprise/",
-            // position: "left",
-            // label: "Platform Enterprise",
-            type: 'html',
-            position: 'left',
-            value: '<a href="https://docs.seqera.io/platform-enterprise/" class="menu__link">Platform Enterprise</a>'
+            to: "/platform-enterprise",
+            position: "left",
+            label: "Platform Enterprise",
           },
           {
             type: "docsVersionDropdown",
@@ -332,28 +328,19 @@ export default async function createConfigAsync() {
             target: "_blank",
           },
           {
-            // to: "/multiqc/",
-            // label: "MultiQC",
-            // position: "left",
-            type: 'html',
-            position: 'left',
-            value: '<a href="https://docs.seqera.io/multiqc/" class="menu__link">MultiQC</a>'
+            to: "/multiqc",
+            label: "MultiQC",
+            position: "left",
           },
           {
-            // to: "/wave/",
-            // label: "Wave",
-            // position: "left",
-            type: 'html',
-            position: 'left',
-            value: '<a href="https://docs.seqera.io/wave/" class="menu__link">Wave</a>'
+            to: "/wave",
+            label: "Wave",
+            position: "left",
           },
           {
-            // to: "/fusion/",
-            // label: "Fusion",
-            // position: "left",
-            type: 'html',
-            position: 'left',
-            value: '<a href="https://docs.seqera.io/fusion/" class="menu__link">Fusion</a>'
+            to: "/fusion",
+            label: "Fusion",
+            position: "left",
           },
           {
             to: "https://training.nextflow.io/latest/",
@@ -362,36 +349,33 @@ export default async function createConfigAsync() {
             target: "_blank",
           },
           {
-            // to: "/platform-api/info/seqera-api",
-            // label: "Platform API",
-            // position: "left",
-            type: 'html',
-            position: 'left',
-            value: '<a href="https://docs.seqera.io/platform-api/info/seqera-api" class="menu__link">Platform API</a>'
+            to: "/platform-api",
+            label: "Platform API",
+            position: "left",
           },
         ],
       },
       footer: {
         style: "dark",
         logo: {
-          alt: 'Seqera Docs logo',
-          src: 'img/icon.svg', 
+          alt: "Seqera Docs logo",
+          src: "img/icon.svg",
           srcDark: "img/iconLight.svg",
-          href: 'https://docs.seqera.io', 
-          width: 25,  
-          height: 25, 
+          href: "https://docs.seqera.io",
+          width: 25,
+          height: 25,
         },
         links: [
           {
             title: "Docs",
             items: [
               {
                 label: "Platform Enterprise",
-                to: "/platform-enterprise/",
+                to: "/platform-enterprise",
               },
               {
                 label: "Platform Cloud",
-                to: "/platform-cloud/",
+                to: "/platform-cloud",
               },
             ],
           },
@@ -461,7 +445,6 @@ export default async function createConfigAsync() {
           language: "powershell",
           logoClass: "powershell",
         },
-
       ],
       prism: {
         theme: themes.oneLight,

netlify.toml

@@ -14,19 +14,20 @@
   # Reference: https://github.com/facebook/docusaurus/discussions/11199
   DOCUSAURUS_SSG_WORKER_THREAD_COUNT = "1"
 
-# Redirects for the missing API docs
+[context.deploy-preview.build.environment]
+  INCLUDE_NEXT="true"
+
+# Seqera API docs are too large to host / build on netlify on their own.
+# The appropriate ENVVAR is set to disable the API Builds on Netlify for the main docs site. 
 [[redirects]]
   from = "/platform-api/*"
   to = "https://seqera-docs-api.netlify.app/platform-api/:splat"
   status = 200
 
-[context.deploy-preview.build.environment]
-  INCLUDE_NEXT="true"
 
 # Redirect missing assets (so that we don't lose CSS on the API docs)
 # NB: Force is not true, so will use local if available
 [[redirects]]
   from = "/assets/*"
   to = "https://seqera-docs-api.netlify.app/assets/:splat"
   status = 200
-