Uh oh!
There was an error while loading. Please reload this page.
Fix the Kubernetes operator links, install command, and missing content sync - #135
Merged
guanzhousongmicrosoft merged 2 commits intoAug 3, 2026
Conversation
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 documentdb#62 lands.
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; documentdb#62 has landed, so the target exists.
guanzhousongmicrosoft
approved these changes
Aug 3, 2026
Uh oh!
There was an error while loading. Please reload this page.
GuanzhouSong added a commit
to GuanzhouSong/documentdb.github.io
that referenced
this pull request
Aug 3, 2026
The packages quick start links to docs/v1/building.md in the engine repository, which returns 404 - that path no longer exists. Build instructions for the packages now live in packaging/README.md, and the link text is adjusted to match what the target actually covers. The blog link this branch also carried was fixed in documentdb#135; that hunk is dropped rather than rebased, leaving only the change still needed.
GuanzhouSong added a commit
to GuanzhouSong/documentdb.github.io
that referenced
this pull request
Aug 3, 2026
documentdb#135 fixed the 404 behind this constant by adding the missing version segment, so the links work now, but all four call sites label themselves "Open quick start" and land on the documentation home instead - the reader still has to find the quick start from there. Renamed the constant for what every caller actually wants and pointed it at the kind quick start, which is the operator's canonical local walkthrough. Linking the page directly also skips the redirect stubs at /documentdb-kubernetes-operator/ and .../latest/, which are meta refreshes that only browsers follow. No call site is left wanting the docs home, so the old name is gone rather than kept as a second export.
This was referenced Aug 3, 2026
guanzhousongmicrosoft pushed a commit
that referenced
this pull request
Aug 3, 2026
#135 fixed the 404 behind this constant by adding the missing version segment, so the links work now, but all four call sites label themselves "Open quick start" and land on the documentation home instead - the reader still has to find the quick start from there. Renamed the constant for what every caller actually wants and pointed it at the kind quick start, which is the operator's canonical local walkthrough. Linking the page directly also skips the redirect stubs at /documentdb-kubernetes-operator/ and .../latest/, which are meta refreshes that only browsers follow. No call site is left wanting the docs home, so the old name is gone rather than kept as a second export.
guanzhousongmicrosoft pushed a commit
that referenced
this pull request
Aug 3, 2026
The packages quick start links to docs/v1/building.md in the engine repository, which returns 404 - that path no longer exists. Build instructions for the packages now live in packaging/README.md, and the link text is adjusted to match what the target actually covers. The blog link this branch also carried was fixed in #135; that hunk is dropped rather than rebased, leaving only the change still needed.
This was referenced Aug 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Every link we offer a reader who wants to learn about the Kubernetes operator is a 404, the install command we show them installs a four-month-old chart, and the docs section that just merged in documentdb/docs#62 never gets built at all.
The section that does not build
documentdb/docs#62added akubernetes-operatorsection. It is unreachable:content.config.jsonenumerates 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.https://documentdb.io/docs/kubernetes-operator/returns the not-found fallback right now. Added the mapping alongside the other four.With the section building, the
/docslanding entry for the operator now points at documentation rather than at this marketing page, which is what every other entry on that page does.The broken links
documentdbKubernetesOperatorDocsUrlishttps://documentdb.io/documentdb-kubernetes-operator/preview/. The operator publishes its documentation under a version segment, so the working URL ishttps://documentdb.io/documentdb-kubernetes-operator/latest/preview/.The constant is used in five places, so this is not a single dead link:
app/kubernetes-operator/page.tsx:282— the page's primary call to actionapp/kubernetes-operator/page.tsx:469,:493app/page.tsx:552— the home pageThe stale install command
The operator page installs from the classic chart repository:
That repository is still served, but its
index.yamltops out at chart 0.2.0 / appVersion 0.2.0, published 2026-03-26. The current chart is 0.3.0, and the operator now publishes it as an OCI artifact, which is what its README and its own quickstarts use.The version gap matters more than it looks: 0.3.0 is where the ImageVolume capability check and its admission webhook landed, so a reader who follows our page gets an operator that behaves differently from every guide they will read next. Replaced with the OCI install the operator documents.
Also
The March operator blog post links to a backup and restore guide that has since moved under
preview/operations/. Fixed in the same pass, since it was found by the same check.Verification
All URLs were checked against the live site, including the chart repository index.
content.config.jsonparses.