Feat/restructure

gatsby-node.js

@@ -8,7 +8,7 @@ const {
   createDocSearch,
   create404,
 } = require("./gatsby/create-pages");
-const { createExtraType } = require("./gatsby/create-types");
+const { createFrontmatter, createNavs } = require("./gatsby/create-types");
 const {
   createConditionalToc,
 } = require("./gatsby/plugin/conditional-toc/conditional-toc");
@@ -26,6 +26,7 @@ exports.createPages = async ({ graphql, actions }) => {
 };
 
 exports.createSchemaCustomization = (options) => {
-  createExtraType(options);
+  createFrontmatter(options);
+  createNavs(options);
   createConditionalToc(options);
 };

gatsby/cloud-plan.ts

@@ -1,7 +1,8 @@
 import { mdxAstToToc, TocQueryData } from "./toc";
 import { generateConfig } from "./path";
 import { extractFilesFromToc } from "./toc-filter";
-import { CloudPlan } from "shared/interface";
+import { CloudPlan } from "../src/shared/interface";
+import { calculateFileUrl } from "./url-resolver";
 
 type TocMap = Map<
   string,
@@ -46,7 +47,8 @@ export async function getTidbCloudFilesFromTocs(graphql: any): Promise<TocMap> {
 
   tocNodes.forEach((node: TocQueryData["allMdx"]["nodes"][0]) => {
     const { config } = generateConfig(node.slug);
-    const toc = mdxAstToToc(node.mdxAST.children, config);
+    const tocPath = calculateFileUrl(node.slug);
+    const toc = mdxAstToToc(node.mdxAST.children, tocPath || node.slug);
     const files = extractFilesFromToc(toc);
 
     // Create a key for this specific locale/repo/version combination
@@ -59,13 +61,13 @@ export async function getTidbCloudFilesFromTocs(graphql: any): Promise<TocMap> {
     let tocType: CloudPlan | null = null;
 
     if (relativePath.includes("TOC.md")) {
-      tocType = "dedicated";
+      tocType = CloudPlan.Dedicated;
     } else if (relativePath.includes("TOC-tidb-cloud-starter")) {
-      tocType = "starter";
+      tocType = CloudPlan.Starter;
     } else if (relativePath.includes("TOC-tidb-cloud-essential")) {
-      tocType = "essential";
+      tocType = CloudPlan.Essential;
     } else if (relativePath.includes("TOC-tidb-cloud-premium")) {
-      tocType = "premium";
+      tocType = CloudPlan.Premium;
     }
 
     // Initialize the entry if it doesn't exist
@@ -118,12 +120,12 @@ export function determineInDefaultPlan(
 
   // Check if article is in TOC.md (dedicated)
   if (dedicated.has(fileName)) {
-    return "dedicated";
+    return CloudPlan.Dedicated;
   }
 
   // Check if article is in TOC-tidb-cloud-starter.md but not in TOC.md
   if (starter.has(fileName) && !dedicated.has(fileName)) {
-    return "starter";
+    return CloudPlan.Starter;
   }
 
   // Check if article is only in TOC-tidb-cloud-essential.md
@@ -132,7 +134,7 @@ export function determineInDefaultPlan(
     !dedicated.has(fileName) &&
     !starter.has(fileName)
   ) {
-    return "essential";
+    return CloudPlan.Essential;
   }
 
   if (
@@ -141,7 +143,7 @@ export function determineInDefaultPlan(
     !dedicated.has(fileName) &&
     !starter.has(fileName)
   ) {
-    return "premium";
+    return CloudPlan.Premium;
   }
 
   return null;

gatsby/create-pages/create-doc-home.ts

@@ -3,13 +3,16 @@ import { resolve } from "path";
 import type { CreatePagesArgs } from "gatsby";
 import sig from "signale";
 
-import { Locale, BuildType } from "../../src/shared/interface";
+import {
+  Locale,
+  BuildType,
+  TOCNamespace,
+  TOCNamespaceSlugMap,
+} from "../../src/shared/interface";
 import {
   generateConfig,
-  generateNav,
+  generateNavTOCPath,
   generateDocHomeUrl,
-  generateStarterNav,
-  generateEssentialNav,
 } from "../../gatsby/path";
 import { DEFAULT_BUILD_TYPE, PageQueryData } from "./interface";
 
@@ -86,9 +89,14 @@ export const createDocHome = async ({
   nodes.forEach((node) => {
     const { id, name, pathConfig, filePath, slug } = node;
     const path = generateDocHomeUrl(name, pathConfig);
-    const navUrl = generateNav(pathConfig);
-    const starterNavUrl = generateStarterNav(pathConfig);
-    const essentialNavUrl = generateEssentialNav(pathConfig);
+    const namespace = TOCNamespace.Home;
+    const namespaceSlug = TOCNamespaceSlugMap[namespace];
+    const navUrl = generateNavTOCPath(pathConfig, namespaceSlug);
+    const starterNavUrl = generateNavTOCPath(pathConfig, "tidb-cloud-starter");
+    const essentialNavUrl = generateNavTOCPath(
+      pathConfig,
+      "tidb-cloud-essential"
+    );
     const locale =
       process.env.WEBSITE_BUILD_TYPE === "archive"
         ? [Locale.en, Locale.zh]
@@ -118,6 +126,7 @@ export const createDocHome = async ({
           feedback: true,
           globalHome: true,
         },
+        namespace,
       },
     });
   });

gatsby/create-pages/create-docs.ts

@@ -3,14 +3,19 @@ import { resolve } from "path";
 import type { CreatePagesArgs } from "gatsby";
 import sig from "signale";
 
-import { Locale, Repo, BuildType } from "../../src/shared/interface";
+import {
+  Locale,
+  Repo,
+  BuildType,
+  TOCNamespaceSlugMap,
+  TOCNamespace,
+} from "../../src/shared/interface";
 import {
   generateConfig,
-  generateUrl,
-  generateNav,
-  generateStarterNav,
-  generateEssentialNav,
+  generateNavTOCPath,
+  getTOCNamespace,
 } from "../../gatsby/path";
+import { calculateFileUrl } from "../../gatsby/url-resolver";
 import { cpMarkdown } from "../../gatsby/cp-markdown";
 import {
   getTidbCloudFilesFromTocs,
@@ -112,10 +117,22 @@ export const createDocs = async (createPagesArgs: CreatePagesArgs) => {
       return;
     }
 
-    const path = generateUrl(name, pathConfig);
-    const navUrl = generateNav(pathConfig);
-    const starterNavUrl = generateStarterNav(pathConfig);
-    const essentialNavUrl = generateEssentialNav(pathConfig);
+    const path = calculateFileUrl(node.slug, true);
+    if (!path) {
+      console.info(
+        `Failed to calculate URL for ${node.slug}, filePath: ${filePath}`
+      );
+      return;
+    }
+
+    const namespace = getTOCNamespace(node.slug);
+    const namespaceSlug = TOCNamespaceSlugMap[namespace];
+    const navUrl = generateNavTOCPath(pathConfig, namespaceSlug);
+    const starterNavUrl = generateNavTOCPath(pathConfig, "tidb-cloud-starter");
+    const essentialNavUrl = generateNavTOCPath(
+      pathConfig,
+      "tidb-cloud-essential"
+    );
 
     const locale = [Locale.en, Locale.zh, Locale.ja]
       .map((l) =>
@@ -157,6 +174,7 @@ export const createDocs = async (createPagesArgs: CreatePagesArgs) => {
           feedback: true,
         },
         inDefaultPlan,
+        namespace,
       },
     });
 

gatsby/create-pages/interface.ts

@@ -8,6 +8,10 @@ export interface PageQueryData {
       id: string;
       frontmatter: { aliases: string[] };
       slug: string;
+      parent: {
+        fileAbsolutePath: string;
+        relativePath: string;
+      } | null;
     }[];
   };
 }

gatsby/create-types/create-frontmatter.ts

@@ -0,0 +1,29 @@
+import { CreatePagesArgs } from "gatsby";
+
+export const createFrontmatter = ({ actions }: CreatePagesArgs) => {
+  const { createTypes } = actions;
+
+  const typeDefs = `
+    """
+    Markdown Node
+    """
+    type Mdx implements Node @dontInfer {
+      frontmatter: Frontmatter
+    }
+
+    """
+    Markdown Frontmatter
+    """
+    type Frontmatter {
+      title: String!
+      summary: String
+      aliases: [String!]
+      draft: Boolean
+      hide_sidebar: Boolean
+      hide_commit: Boolean
+      hide_leftNav: Boolean
+    }
+  `;
+
+  createTypes(typeDefs);
+};

gatsby/create-types.ts → gatsby/create-types/create-navs.ts

@@ -1,35 +1,11 @@
 import { CreatePagesArgs } from "gatsby";
-import { generateConfig } from "./path";
-import { mdxAstToToc } from "./toc";
-import { Root, List } from "mdast";
+import { mdxAstToToc } from "../toc";
+import { Root } from "mdast";
+import { calculateFileUrl } from "../url-resolver";
 
-export const createExtraType = ({ actions }: CreatePagesArgs) => {
+export const createNavs = ({ actions }: CreatePagesArgs) => {
   const { createTypes, createFieldExtension } = actions;
 
-  const typeDefs = `
-    """
-    Markdown Node
-    """
-    type Mdx implements Node @dontInfer {
-      frontmatter: Frontmatter
-    }
-
-    """
-    Markdown Frontmatter
-    """
-    type Frontmatter {
-      title: String!
-      summary: String
-      aliases: [String!]
-      draft: Boolean
-      hide_sidebar: Boolean
-      hide_commit: Boolean
-      hide_leftNav: Boolean
-    }
-  `;
-
-  createTypes(typeDefs);
-
   createFieldExtension({
     name: "navigation",
     extend() {
@@ -55,10 +31,13 @@ export const createExtraType = ({ actions }: CreatePagesArgs) => {
             }
           );
 
-          if (!slug.endsWith("TOC"))
-            throw new Error(`unsupported query in ${slug}`);
-          const { config } = generateConfig(slug);
-          const res = mdxAstToToc(mdxAST.children, config, undefined, true);
+          const tocPath = calculateFileUrl(slug);
+          const res = mdxAstToToc(
+            mdxAST.children,
+            tocPath || slug,
+            undefined,
+            true
+          );
           mdxNode.nav = res;
           return res;
         },
@@ -93,8 +72,13 @@ export const createExtraType = ({ actions }: CreatePagesArgs) => {
 
           if (!slug.endsWith("TOC-tidb-cloud-starter"))
             throw new Error(`unsupported query in ${slug}`);
-          const { config } = generateConfig(slug);
-          const res = mdxAstToToc(mdxAST.children, config, undefined, true);
+          const tocPath = calculateFileUrl(slug);
+          const res = mdxAstToToc(
+            mdxAST.children,
+            tocPath || slug,
+            undefined,
+            true
+          );
           mdxNode.starterNav = res;
           return res;
         },
@@ -129,8 +113,13 @@ export const createExtraType = ({ actions }: CreatePagesArgs) => {
 
           if (!slug.endsWith("TOC-tidb-cloud-essential"))
             throw new Error(`unsupported query in ${slug}`);
-          const { config } = generateConfig(slug);
-          const res = mdxAstToToc(mdxAST.children, config, undefined, true);
+          const tocPath = calculateFileUrl(slug);
+          const res = mdxAstToToc(
+            mdxAST.children,
+            tocPath || slug,
+            undefined,
+            true
+          );
           mdxNode.essentialNav = res;
           return res;
         },

gatsby/create-types/index.ts

@@ -0,0 +1,2 @@
+export * from "./create-frontmatter";
+export * from "./create-navs";