website: support hidden pages in nav-data (#10510)

* website: bump to docs-page prerelease with hidden page support

* website: remove temp check for hidden pages, covered by docs-page

* website: bump to stable docs-page, w next-mdx-remote bump

.github/workflows/check-unlinked-content.js

@@ -1,134 +0,0 @@
-var fs = require("fs");
-var path = require("path");
-
-const COLOR_RESET = "\x1b[0m";
-const COLOR_GREEN = "\x1b[32m";
-const COLOR_RED = "\x1b[31m";
-
-runCheck([
-  {
-    contentDir: "website/content/docs",
-    navDataFile: "website/data/docs-nav-data.json",
-  },
-  {
-    contentDir: "website/content/api-docs",
-    navDataFile: "website/data/api-docs-nav-data.json",
-  },
-  {
-    contentDir: "website/content/intro",
-    navDataFile: "website/data/intro-nav-data.json",
-  },
-]);
-
-async function runCheck(baseRoutes) {
-  const validatedBaseRoutes = await Promise.all(
-    baseRoutes.map(async ({ contentDir, navDataFile }) => {
-      const missingRoutes = await validateMissingRoutes(
-        contentDir,
-        navDataFile
-      );
-      return { contentDir, navDataFile, missingRoutes };
-    })
-  );
-  const allMissingRoutes = validatedBaseRoutes.reduce((acc, baseRoute) => {
-    return acc.concat(baseRoute.missingRoutes);
-  }, []);
-  if (allMissingRoutes.length == 0) {
-    console.log(
-      `\n${COLOR_GREEN}✓ All content files have routes, and are included in navigation data.${COLOR_RESET}\n`
-    );
-  } else {
-    validatedBaseRoutes.forEach(
-      ({ contentDir, navDataFile, missingRoutes }) => {
-        if (missingRoutes.length == 0) return true;
-        console.log(
-          `\n${COLOR_RED}Error: Missing pages found in the ${contentDir} directory.\n\nPlease add these paths to ${navDataFile}, or remove the .mdx files.\n\n${JSON.stringify(
-            missingRoutes,
-            null,
-            2
-          )}${COLOR_RESET}\n\n`
-        );
-      }
-    );
-    process.exit(1);
-  }
-}
-
-async function validateMissingRoutes(contentDir, navDataFile) {
-  // Read in nav-data.json, and make a flattened array of nodes
-  const navDataPath = path.join(process.cwd(), navDataFile);
-  const navData = JSON.parse(fs.readFileSync(navDataPath));
-  const navDataFlat = flattenNodes(navData);
-  // Read all files in the content directory
-  const files = await walkAsync(contentDir);
-  // Filter out content files that are already
-  // included in nav-data.json
-  const missingPages = files
-    // Ignore non-.mdx files
-    .filter((filePath) => {
-      return path.extname(filePath) == ".mdx";
-    })
-    // Transform the filePath into an expected route
-    .map((filePath) => {
-      // Get the relative filepath, that's what we'll see in the route
-      const contentDirPath = path.join(process.cwd(), contentDir);
-      const relativePath = path.relative(contentDirPath, filePath);
-      // Remove extensions, these will not be in routes
-      const pathNoExt = relativePath.replace(/\.mdx$/, "");
-      // Resolve /index routes, these will not have /index in their path
-      const routePath = pathNoExt.replace(/\/?index$/, "");
-      return routePath;
-    })
-    // Determine if there is a match in nav-data.
-    // If there is no match, then this is an unlinked content file.
-    .filter((pathToMatch) => {
-      // If it's the root path index page, we know
-      // it'll be rendered (hard-coded into docs-page/server.js)
-      const isIndexPage = pathToMatch === "";
-      if (isIndexPage) return false;
-      // Otherwise, needs a path match in nav-data
-      const matches = navDataFlat.filter(({ path }) => path == pathToMatch);
-      return matches.length == 0;
-    });
-  return missingPages;
-}
-
-function flattenNodes(nodes) {
-  return nodes.reduce((acc, n) => {
-    if (!n.routes) return acc.concat(n);
-    return acc.concat(flattenNodes(n.routes));
-  }, []);
-}
-
-function walkAsync(relativeDir) {
-  const dirPath = path.join(process.cwd(), relativeDir);
-  return new Promise((resolve, reject) => {
-    walk(dirPath, function (err, result) {
-      if (err) reject(err);
-      resolve(result);
-    });
-  });
-}
-
-function walk(dir, done) {
-  var results = [];
-  fs.readdir(dir, function (err, list) {
-    if (err) return done(err);
-    var pending = list.length;
-    if (!pending) return done(null, results);
-    list.forEach(function (file) {
-      file = path.resolve(dir, file);
-      fs.stat(file, function (err, stat) {
-        if (stat && stat.isDirectory()) {
-          walk(file, function (err, res) {
-            results = results.concat(res);
-            if (!--pending) done(null, results);
-          });
-        } else {
-          results.push(file);
-          if (!--pending) done(null, results);
-        }
-      });
-    });
-  });
-}

.github/workflows/check-unlinked-content.yml

@@ -1,26 +0,0 @@
-#
-# This GitHub action checks that all .mdx files in the
-# the website/content directory are being published.
-# It fails if any of these files are not included
-# in the expected nav-data.json file.
-#
-# To resolve failed checks, add the listed paths
-# to the corresponding nav-data.json file
-# in website/data.
-
-name: "website: Check unlinked content"
-on:
-  pull_request:
-    paths:
-      - "website/**"
-
-jobs:
-  check-unlinked-content:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Setup Node
-        uses: actions/setup-node@v1
-      - name: Check that all content files are included in navigation
-        run: node .github/workflows/check-unlinked-content.js

website/next.config.js

@@ -5,7 +5,11 @@ const rewrites = require('./rewrites')
 
 module.exports = withHashicorp({
   defaultLayout: true,
-  transpileModules: ['is-absolute-url', '@hashicorp/react-.*'],
+  transpileModules: [
+    'is-absolute-url',
+    '@hashicorp/react-.*',
+    '@hashicorp/versioned-docs',
+  ],
   mdx: { resolveIncludes: path.join(__dirname, 'pages/partials') },
 })({
   redirects() {

website/package.json

@@ -14,7 +14,7 @@
     "@hashicorp/react-button": "5.0.1",
     "@hashicorp/react-call-to-action": "3.0.1",
     "@hashicorp/react-content": "7.0.1",
-    "@hashicorp/react-docs-page": "13.1.1",
+    "@hashicorp/react-docs-page": "13.2.0",
     "@hashicorp/react-featured-slider": "4.0.2",
     "@hashicorp/react-hashi-stack-menu": "2.0.3",
     "@hashicorp/react-hero": "7.1.2",
@@ -32,7 +32,7 @@
     "@hashicorp/react-vertical-text-block-list": "6.0.2",
     "marked": "0.7.0",
     "next": "10.1.3",
-    "next-mdx-remote": "^2.1.4",
+    "next-mdx-remote": "3.0.1",
     "next-remote-watch": "^1.0.0",
     "nuka-carousel": "4.7.7",
     "react": "16.14.0",