Skip to content

Prepare the docs for the DocumentDB 1.0 release - #88

Merged
guanzhousongmicrosoft merged 13 commits into
documentdb:mainfrom
GuanzhouSong:guanzhousong/docs-1.0-ga
Oct 18, 2026
Merged

guanzhousongmicrosoft merged 13 commits into
documentdb:mainfrom
GuanzhouSong:guanzhousong/docs-1.0-ga

Conversation

@GuanzhouSong

@GuanzhouSong GuanzhouSong commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

At 1.0 GA (2026-10-19) these docs are wrong in ways users hit:

  • :latest moves to the 1.0 image, which sends usage telemetry by default. The quick starts and the DocumentDB Local page say nothing about it, or say the image sends none.
  • The packages page says in-place upgrades aren't supported. 1.0 supports upgrading from 0.116/0.117, but only after a PostgreSQL restart and ALTER EXTENSION ... UPDATE, and re-running the setup wizard resets the admin password. A newer container image never updates an old volume ([documentdb-local] Lifecycle, upgrade and settings gaps in the container image documentdb#773), so the page says to dump and restore.
  • Community builds from v1.0-0 can come out as 1.0~rc2, because the tag shares a commit with v1.0-RC2; the page now passes --version 1.0.0.
  • The RC page advertises a test build that is over. It becomes a short retirement note, and a permanent 1.0 release notes page carries what's new and the known issues.

Everything was checked against v1.0-RC2, the same commit as GA, and the examples were run on the RC2 images. That turned up errors the RC docs repeated:

  • distinct or count on a grouped view still crashes PostgreSQL.
  • $changeStream always fails.
  • The $jsonSchema lists and examples were wrong.
  • Collation is off by default, and some commands never accept it.
  • The Postgres API pages still described 0.114.

Merge order: merge this before website PR documentdb/documentdb.github.io#219 on release day. Docs merges don't trigger a site deploy, so if #219 merges first, re-dispatch the site deploy after this one.

Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
The build scripts need --version 1.0.0: v1.0-0 shares a commit with v1.0-RC2, so git describe can pick the RC tag and build 1.0~rc2.

Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
1.0 turns usage telemetry on by default and doesn't upgrade an existing volume (#773).

Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
The quick starts pull :latest, which moves to 1.0. The prompts also switch to printf + read because zsh's read -p means something else.

Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
1.0 refuses to load pg_documentdb_extended_rum unless it is preloaded, which a 0.116 brownfield install may lack.

Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
…zard

docker run doesn't forward the runner's CI variables, and a 0.117 container that was killed leaves a postmaster.pid the 1.0 image refuses.

Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
The grouped-view crash still reproduces on RC2, the wizard re-run resets the admin password, and the manual upgrade could commit half-way. Upgrade recipes now stop on failure and cover adopted and multi-major hosts; examples were run against the RC2 image.

Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
A failed restart left psql updating the catalog under the old libraries. Also: CI markers must be non-empty, the role $db check depends on enableRolesAdminDBCheck, skipFailOnCollation doesn't behave as described, and usernames keep surrounding spaces.

Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
The target restart brought the gateway up on the new libraries while the wizard was still updating the extensions.

Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com>
The adopted paths left the old gateway serving while PostgreSQL ran new libraries against old catalogs; a -p value also sat in the client's argv and broke on a leading dash.

Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com>
Sign up for free to 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.

3 participants