Update Docusaurus to 3.6 and enable faster builds (#3989)

* Update Docusaurus to 3.6 and enable faster builds Signed-off-by: Timothy Johnson <[email protected]> * Try fetching history for single branch Signed-off-by: Timothy Johnson <[email protected]> --------- Signed-off-by: Timothy Johnson <[email protected]>
zowe · Nov 11, 2024 · 8c0b872 · 8c0b872
1 parent 8a73fe7
commit 8c0b872
Show file tree

Hide file tree

Showing 10 changed files with 4,194 additions and 2,640 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -30,7 +30,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          # Fetches all commit history for a single branch. We need commit
+          # history for accurate "last updated" dates on each page, but fetch
+          # depth of 0 would fetch all branches which is slow.
+          # https://github.com/actions/checkout/issues/520#issuecomment-1320838255
+          fetch-depth: 2147483647
 
       - name: Use Node.js LTS
         uses: actions/setup-node@v3
@@ -43,7 +47,7 @@ jobs:
         env:
           TAR_OPTIONS: "--remove-files"
         with:
-          path: node_modules/.cache/webpack
+          path: node_modules/.cache/rspack
           key: cache-webpack-${{ github.base_ref || github.ref_name }}
 
       - name: Install Dependencies

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -3,8 +3,7 @@ const versionsArray = require("./versions.json");
 
 module.exports = {
   title: "Zowe Docs",
-  tagline:
-    "Combining the past and the present to build the future of Mainframe",
+  tagline: "Combining the past and the present to build the future of Mainframe",
   url: "https://docs.zowe.org/",
   baseUrl: "/",
   onBrokenLinks: "warn",
@@ -18,18 +17,12 @@ module.exports = {
       comments: true
     }
   },
-  webpack: {
-    jsLoader: (isServer) => ({
-      loader: require.resolve("esbuild-loader"),
-      options: {
-        loader: "tsx",
-        format: isServer ? "cjs" : undefined,
-        target: isServer ? "node12" : "es2017",
-      },
-    }),
+  future: {
+    // https://docusaurus.io/blog/releases/3.6#docusaurus-faster
+    experimental_faster: true,
   },
   themeConfig: {
-        docs: {
+    docs: {
       sidebar: {
         hideable: true
       }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -16,16 +16,16 @@
     "docs:pdf:user": "npx docs-to-pdf --initialDocURLs=\"http://localhost:3000/stable/getting-started/overview,http://localhost:3000/stable/user-guide/installandconfig,http://localhost:3000/stable/troubleshoot/troubleshooting\" --contentSelector=\"article\" --paginationSelector=\".pagination-nav__link--next\" --cssStyle=\":root{--ifm-font-size-base: 60%;}\" --excludeSelectors=\".announcementBar_UUUQ,nav.navbar,.docSidebarContainer_3pwe,.docMainContainer_2pgU .col.col--3,footer.footer,.docItemContainer_2szM > .margin-vert--xl > .row > .col:first-child,.pagination-nav,.docsRating,.navbar__inner,.thin-scrollbar\" --coverImage=\"http://localhost:3000/img/zowe-icon.png\" --coverTitle=\"Zowe Documentation\" --outputPDFFilename=\"static/zowe-docs-user.pdf\" --protocolTimeout=1800000"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.4.0",
-    "@docusaurus/plugin-client-redirects": "^3.4.0",
-    "@docusaurus/plugin-pwa": "^3.4.0",
-    "@docusaurus/preset-classic": "^3.4.0",
-    "@mdx-js/react": "^3.0.0",
+    "@docusaurus/core": "^3.6.1",
+    "@docusaurus/faster": "^3.6.1",
+    "@docusaurus/plugin-client-redirects": "^3.6.1",
+    "@docusaurus/plugin-pwa": "^3.6.1",
+    "@docusaurus/preset-classic": "^3.6.1",
+    "@mdx-js/react": "^3.1.0",
     "clsx": "^2.1.1",
-    "esbuild-loader": "^4.2.2",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "react-medium-image-zoom": "^5.2.8",
+    "react-medium-image-zoom": "^5.2.10",
     "reading-time": "^1.5.0"
   },
   "devDependencies": {

diff --git a/src/theme/DocItem/DocContent.js b/src/theme/DocItem/DocContent.js
@@ -5,8 +5,8 @@ import { MDXProvider } from "@mdx-js/react";
 import {
   useDoc,
   useDocsVersion,
-  useTitleFormatter,
-} from "@docusaurus/theme-common/internal";
+} from "@docusaurus/plugin-content-docs/client";
+import { useTitleFormatter } from "@docusaurus/theme-common/internal";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import useBaseUrl from "@docusaurus/useBaseUrl";
 import DocPaginator from "@theme/DocPaginator";

diff --git a/src/theme/DocItem/Layout.js b/src/theme/DocItem/Layout.js
@@ -3,7 +3,7 @@
 import React from 'react';
 import clsx from 'clsx';
 import {useWindowSize} from '@docusaurus/theme-common';
-import {useDoc} from '@docusaurus/theme-common/internal';
+import {useDoc} from '@docusaurus/plugin-content-docs/client';
 import DocItemPaginator from '@theme/DocItem/Paginator';
 import DocVersionBanner from '@theme/DocVersionBanner';
 import DocVersionBadge from '@theme/DocVersionBadge';

diff --git a/src/theme/DocItem/index.js b/src/theme/DocItem/index.js
@@ -1,6 +1,6 @@
 import React, { useEffect, useRef, useState } from "react";
 import readingTime from "reading-time/lib/reading-time";
-import { DocProvider } from "@docusaurus/theme-common/internal";
+import { DocProvider } from "@docusaurus/plugin-content-docs/client";
 
 //Components
 import { DocContent } from "./DocContent";

diff --git a/src/theme/DocVersionBanner/index.js b/src/theme/DocVersionBanner/index.js
@@ -8,9 +8,8 @@ import React from 'react';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import Link from '@docusaurus/Link';
 import Translate from '@docusaurus/Translate';
-import {useActivePlugin, useDocVersionSuggestions} from '@docusaurus/plugin-content-docs/client';
+import {useActivePlugin, useDocsVersion, useDocVersionSuggestions} from '@docusaurus/plugin-content-docs/client';
 import {useDocsPreferredVersion} from '@docusaurus/theme-common';
-import {useDocsVersion} from "@docusaurus/theme-common/internal";
 
 function UnreleasedVersionLabel({siteTitle, versionMetadata}) {
   return (

diff --git a/src/theme/MDXComponents/Tpsr.js b/src/theme/MDXComponents/Tpsr.js
@@ -2,7 +2,7 @@ import React from "react";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import {
   useDocsVersion,
-} from "@docusaurus/theme-common/internal";
+} from "@docusaurus/plugin-content-docs/client";
 
 function Tpsr() {
   const { siteConfig } = useDocusaurusContext();

diff --git a/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.js b/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.js
@@ -6,7 +6,7 @@ import {
   useActiveDocContext,
 } from '@docusaurus/plugin-content-docs/client';
 import {useDocsPreferredVersion} from '@docusaurus/theme-common';
-import {useDocsVersionCandidates} from '@docusaurus/theme-common/internal';
+import {useDocsVersionCandidates} from '@docusaurus/plugin-content-docs/client';
 import {translate} from '@docusaurus/Translate';
 import {useLocation} from '@docusaurus/router';
 import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';