From 0a6bef14135d541974e502cbcb5bed9fcf35d344 Mon Sep 17 00:00:00 2001 From: Guanzhou Song Date: Mon, 3 Aug 2026 13:52:19 -0400 Subject: [PATCH] Finish wiring up the kubernetes-operator section Two loose ends from #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 #35 wrote that list while #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 #61 was rewriting that page, and lands now that it has merged. --- documentdb-local/index.md | 8 ++++++++ readme.md | 1 + 2 files changed, 9 insertions(+) diff --git a/documentdb-local/index.md b/documentdb-local/index.md index d11203d..086af1e 100644 --- a/documentdb-local/index.md +++ b/documentdb-local/index.md @@ -170,6 +170,14 @@ For mongosh info see: https://www.mongodb.com/docs/mongodb-shell/ ``` +## Beyond local development + +DocumentDB Local runs a single container on one machine, with no replication and no failover, which is what makes it convenient for development and testing. For other ways to run DocumentDB: + +- [Kubernetes Operator](https://documentdb.io/docs/kubernetes-operator/) - run DocumentDB as a replicated service, with automatic failover, backup and restore, and rolling upgrades. +- [Pre-built packages](https://documentdb.io/docs/getting-started/prebuilt-packages/) - add the DocumentDB extension to a PostgreSQL server you already run. + + ## Reporting issues If you encounter issues with using this version of DocumentDB, open an issue in the GitHub repository () and tag it with the label `documentdb-local`. diff --git a/readme.md b/readme.md index 504e0fc..f373402 100644 --- a/readme.md +++ b/readme.md @@ -31,6 +31,7 @@ Documentation articles are stored in the following folders: - `/architecture` - `/documentdb-local` - `/getting-started` +- `/kubernetes-operator` - `/postgres-api` Each folder contains Markdown files (*\*.md*) and a *navigation.yml* file. Markdown files require the following YAML front matter metadata: