engine: Modify seo behavior

docs/.vuepress/configs/plugins/seo.ts

@@ -1,40 +1,73 @@
-import {SeoPluginOptions} from "@vuepress/plugin-seo";
-import {App, HeadConfig, Page} from "vuepress";
-import {match} from "ts-pattern";
-import {hostname} from "./shared";
+import { SeoPluginOptions } from "@vuepress/plugin-seo";
+import { App, HeadConfig, Page } from "vuepress";
+import { match } from "ts-pattern";
+import { hostname } from "./shared";
 
-const legacy = "Legacy";
+const LEGACY = "Legacy";
+const EXCLUDED_VERSIONS = ["v5", "v24.6"];
+const LATEST_VERSION = "v25.0"; // fallback latest version
 
 export const seoPlugin: SeoPluginOptions = {
-    hostname: hostname,
-    customHead: (head: HeadConfig[], page: Page, app: App) => {
-        if (!page.pathInferred) return;
-
-        const pathSplit = page.pathInferred.split("/");
-        let maybeVersion = pathSplit.length > 1 ? pathSplit[2] : null;
-
-        if (maybeVersion && maybeVersion === "tcp") {
-            maybeVersion = legacy;
-        }
-
-        if (maybeVersion && maybeVersion.startsWith("v") && (maybeVersion.indexOf(".") > 0 || maybeVersion === "v5") || maybeVersion === legacy) {
-            head.push(["meta", {name: "es:version", content: maybeVersion}]);
-        } else {
-        }
-
-        const category = pathSplit.length > 0 ? pathSplit[1] : null;
-        if (!category) {
-            return;
-        }
-        const readableCategory = match(category)
-            .with("server", () => "Server")
-            .with("clients", () => "Client")
-            .with("cloud", () => "Cloud")
-            .with("http-api", () => "HTTP API")
-            .with("connectors", () => "Connectors")
-            .with("getting-started", () => "Getting Started")
-            .otherwise(() => category);
-        head.push(["meta", {name: "es:category", content: readableCategory}]);
-    },
-}
+  hostname,
 
+  canonical: (page: Page) => {
+    const segments = page.pathInferred?.split("/") ?? [];
+    const section = segments[1];
+    const version = segments[2];
+
+    // don’t index/remove unwanted versions
+    if (EXCLUDED_VERSIONS.includes(version)) {
+      return null;
+    }
+
+    // cloud & tutorials always point at root of that section
+    if (section === "cloud" || section === "tutorials") {
+      return `https://docs.kurrent.io/${section}${page.path.slice(
+        section.length + 1
+      )}`;
+    }
+
+    if (version?.startsWith("v")) {
+      const rest = page.path.slice(`/${section}/${version}`.length);
+      return `https://docs.kurrent.io/${section}/${LATEST_VERSION}${rest}`;
+    }
+
+    return `https://docs.kurrent.io${page.path}`;
+  },
+
+  customHead: (head: HeadConfig[], page: Page, app: App) => {
+    if (!page.pathInferred) return;
+
+    const segments = page.pathInferred.split("/");
+    let version = segments.length > 2 ? segments[2] : null;
+
+    // drop indexing on unwanted versions
+    if (version && EXCLUDED_VERSIONS.includes(version)) {
+      head.push(["meta", { name: "robots", content: "noindex,nofollow" }]);
+      return;
+    }
+
+    // map “tcp” to Legacy, then tag es:version if it applies
+    if (version === "tcp") version = LEGACY;
+    if (
+      version &&
+      (version === LEGACY ||
+        (version.startsWith("v") && (version.includes(".") || version === "v5")))
+    ) {
+      head.push(["meta", { name: "es:version", content: version }]);
+    }
+
+    const category = segments[1];
+    if (!category) return;
+    const readable = match(category)
+      .with("server", () => "Server")
+      .with("clients", () => "Client")
+      .with("cloud", () => "Cloud")
+      .with("http-api", () => "HTTP API")
+      .with("connectors", () => "Connectors")
+      .with("getting-started", () => "Getting Started")
+      .otherwise(() => category);
+
+    head.push(["meta", { name: "es:category", content: readable }]);
+  },
+};