Skip to content

Finish wiring up the kubernetes-operator section - #63

Merged
guanzhousongmicrosoft merged 1 commit into
documentdb:mainfrom
GuanzhouSong:docs/kubernetes-operator-followups
Aug 3, 2026
Merged

Finish wiring up the kubernetes-operator section#63
guanzhousongmicrosoft merged 1 commit into
documentdb:mainfrom
GuanzhouSong:docs/kubernetes-operator-followups

Conversation

@GuanzhouSong

Copy link
Copy Markdown
Contributor

Summary

Two loose ends from #62. Both exist because pull requests merged independently of each other and could not have known about each other — neither is a defect in the PRs that created them.

The contributing instructions name four folders where there are five

#35 added the Articles section to readme.md, listing the folders that hold documentation articles. It was written while #62 was still open, so /kubernetes-operator is missing from the list even though it is now a section like any other, with a navigation.yml and the same front matter requirements. A contributor following those instructions would not know it exists.

The documentdb-local page has no route onward

Someone who has just run the container and now wants replication, failover, or rolling upgrades has no reason to guess that the answer lives in a different section of the site. That page is the most likely place in these docs for the question to come up, so it now points at the operator section and at the pre-built packages.

This was deliberately held back while #61 was rewriting documentdb-local/index.md, to avoid handing that PR a conflict. #61 has merged, so it lands now.

Two loose ends from documentdb#62, both created by pull requests that merged
independently of it and could not have known about each other.
The contributing instructions in readme.md list the folders that hold
documentation articles, and documentdb#35 wrote that list while documentdb#62 was still
open, so it names four folders where there are now five. A contributor
following it would not know the kubernetes-operator section exists or
that it follows the same rules.
The documentdb-local page had no route onward. Someone who has just run
the container and wants replication, failover, or rolling upgrades has
no reason to guess that the answer is a different section of the site;
it is the most likely place in these docs for that question to occur, so
it now points at the operator section and at the pre-built packages.
This was deliberately held back while documentdb#61 was rewriting that page, and
lands now that it has merged.
@guanzhousongmicrosoft
guanzhousongmicrosoft merged commit 0ac64db into documentdb:mainAug 3, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@GuanzhouSong@guanzhousongmicrosoft