From e7e1e8b975456ab6275ee6be7f1d2bf1e1cbc1a4 Mon Sep 17 00:00:00 2001 From: Guanzhou Song Date: Mon, 3 Aug 2026 13:45:13 -0400 Subject: [PATCH 1/2] Fix the Kubernetes operator links and install command Every "read the documentation" link we point at the Kubernetes operator is a 404. documentdbKubernetesOperatorDocsUrl is /documentdb-kubernetes-operator/preview/, but the operator publishes its docs under a version segment, at /documentdb-kubernetes-operator/latest/ preview/. The constant is used five times - three on the operator page, including its primary call to action, and once on the home page - so every route we offer a reader who wants to learn about the operator ends at GitHub Pages' not-found page. The install command on the operator page is stale in a quieter way. It installs from the classic chart repository at documentdb.github.io/documentdb-kubernetes-operator, whose index still tops out at chart 0.2.0, published 2026-03-26. The current chart is 0.3.0, and the operator has moved to publishing the chart as an OCI artifact on ghcr.io, which is what its README and its own quickstarts now use. Following our page gets you a four-month-old operator - which matters more than the version gap suggests, because 0.3.0 is where the ImageVolume capability check and its admission webhook landed. Replaced with the OCI install the operator documents. Also fixed a moved link in the March operator blog post: the backup and restore guide is now under preview/operations/. All four URLs were checked against the live site, before and after. Not included, to avoid a cross-repo merge order hazard: the /docs landing entry for the operator points at this marketing page rather than at documentation. documentdb/docs#62 adds a /docs/kubernetes-operator section for it to point to, so that entry is worth updating once #62 lands. --- app/kubernetes-operator/page.tsx | 5 ++--- app/services/externalLinks.ts | 2 +- .../_posts/2026-03-19-meet-documentdb-kubernetes-operator.md | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/app/kubernetes-operator/page.tsx b/app/kubernetes-operator/page.tsx index 78521e5..c62f7c5 100644 --- a/app/kubernetes-operator/page.tsx +++ b/app/kubernetes-operator/page.tsx @@ -227,9 +227,8 @@ const bestFitScenarios = [ "Operators that need failover, backup, promotion, and recovery workflows across clusters.", ] as const; -const operatorQuickStartCommand = `helm repo add documentdb https://documentdb.github.io/documentdb-kubernetes-operator -helm install documentdb-operator documentdb/documentdb-operator \\ - --namespace documentdb-operator --create-namespace`; +const operatorQuickStartCommand = `helm install documentdb-operator oci://ghcr.io/documentdb/documentdb-operator \\ + --namespace documentdb-operator --create-namespace --wait`; export const metadata = getMetadata({ title: "DocumentDB Kubernetes Operator", diff --git a/app/services/externalLinks.ts b/app/services/externalLinks.ts index bc7b4c6..d843eed 100644 --- a/app/services/externalLinks.ts +++ b/app/services/externalLinks.ts @@ -1,7 +1,7 @@ export const documentdbDiscordUrl = 'https://discord.gg/vH7bYu524D'; export const documentdbKubernetesOperatorDocsUrl = - 'https://documentdb.io/documentdb-kubernetes-operator/preview/'; + 'https://documentdb.io/documentdb-kubernetes-operator/latest/preview/'; export const documentdbKubernetesOperatorGitHubUrl = 'https://github.com/documentdb/documentdb-kubernetes-operator'; diff --git a/blogs/_posts/2026-03-19-meet-documentdb-kubernetes-operator.md b/blogs/_posts/2026-03-19-meet-documentdb-kubernetes-operator.md index a3c371a..8908db1 100644 --- a/blogs/_posts/2026-03-19-meet-documentdb-kubernetes-operator.md +++ b/blogs/_posts/2026-03-19-meet-documentdb-kubernetes-operator.md @@ -89,7 +89,7 @@ The public docs are clear that the operator is not yet recommended for productio - [GitHub repository](https://github.com/documentdb/documentdb-kubernetes-operator) — star the project, file issues, and contribute - [Quickstart guide](https://github.com/documentdb/documentdb-kubernetes-operator/blob/main/docs/operator-public-documentation/preview/index.md) -- [Backup and restore guide](https://github.com/documentdb/documentdb-kubernetes-operator/blob/main/docs/operator-public-documentation/preview/backup-and-restore.md) +- [Backup and restore guide](https://github.com/documentdb/documentdb-kubernetes-operator/blob/main/docs/operator-public-documentation/preview/operations/backup-and-restore.md) - [kubectl-documentdb plugin](https://github.com/documentdb/documentdb-kubernetes-operator/blob/main/docs/operator-public-documentation/preview/kubectl-plugin.md) - [TLS configuration guide](https://github.com/documentdb/documentdb-kubernetes-operator/blob/main/docs/operator-public-documentation/preview/configuration/tls.md) - [Multi-cloud deployment playground (AKS + GKE + EKS)](https://github.com/documentdb/documentdb-kubernetes-operator/blob/main/documentdb-playground/multi-cloud-deployment/README.md) From 5cd0c013708939b946b72cd0814f998a7712e46d Mon Sep 17 00:00:00 2001 From: Guanzhou Song Date: Mon, 3 Aug 2026 13:49:04 -0400 Subject: [PATCH 2/2] Sync the kubernetes-operator section so its pages actually build documentdb/docs#62 merged a kubernetes-operator section, and it is unreachable: content.config.json enumerates the folders copied out of the docs repository, so a section missing from that list is never copied, never exported, and 404s permanently rather than until the next deploy. /docs/kubernetes-operator returns the not-found fallback today. Added the mapping alongside the other four. With the section building, the /docs landing entry for the operator can point at documentation instead of at the marketing page, which is what every other entry on that page does. This is the follow-up this branch previously deferred on merge-order grounds; #62 has landed, so the target exists. --- articles/content.yml | 2 +- content.config.json | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/articles/content.yml b/articles/content.yml index b78dbeb..7cf108a 100644 --- a/articles/content.yml +++ b/articles/content.yml @@ -5,7 +5,7 @@ landing: - title: Getting Started with DocumentDB link: /docs/getting-started - title: DocumentDB Kubernetes Operator (Preview) - link: /kubernetes-operator + link: /docs/kubernetes-operator - title: API Reference link: /docs/reference - title: Postgres Extension API diff --git a/content.config.json b/content.config.json index da58990..917e4c2 100644 --- a/content.config.json +++ b/content.config.json @@ -23,6 +23,10 @@ { "source": "documentdb-local", "target": "articles/documentdb-local" + }, + { + "source": "kubernetes-operator", + "target": "articles/kubernetes-operator" } ] }