Clarify package installation and document retired package repositories - #78
Merged
guanzhousongmicrosoft merged 4 commits intoSep 10, 2026
Conversation
guanzhousongmicrosoft
force-pushed
the
dev/guanzhousong/retired-package-repo-cleanup
branch
from
September 10, 2026 16:21
98d04ef to
838027e
Compare
The 0.117 page already states that other targets are outside the hosted package matrix and that older packages are not retained, but it stops short of what an operator on a retired target actually has to do. Record that the withdrawal also pulled the older PostgreSQL 16 extension packages from the Ubuntu 24.04 and RHEL-compatible 9 repositories, that empty signed metadata is deliberately parked at the retired repository URLs so package-manager refreshes keep working, and how to remove the repository configuration. Name the three packaging entry points so a community build of an unhosted target does not require reading the packaging tree first. Verified against the live documentdb.io package guidance and against packaging/build_packages.sh, packaging/gateway/build_gateway_packages.sh and packaging/build_extra_packages.sh in the source repository. Claude-Session: https://claude.ai/code/session_01Bg344Sg5hCgoxD6aPsbp5b
Lead with stand-alone setup and explain component-level PostgreSQL and gateway workflows. Document PGDG and source builds, with release assets and retired-target guidance kept as reference. Copilot-Session: e7d486f5-141c-47f0-ad9e-8bce20fdb52f Signed-off-by: Guanzhou Song <guanzhou.song@gmail.com>
GuanzhouSong
force-pushed
the
dev/guanzhousong/retired-package-repo-cleanup
branch
from
September 10, 2026 16:24
838027e to
8ab8ad6
Compare
The page described a `sampledb` database with `users`, `products`, `orders` and `analytics` collections. That is the v0.116-0 dataset: documentdb-local/sample-data/ held 01-users.js, 02-products.js, 03-orders.js and 04-analytics.js, each seeding `sampledb`. v0.117-0 replaces all four with 01-store-data.js plus two gzipped Extended JSON exports, seeding a `StoreData` database with 41,505 `stores` documents and 2 `ratings` documents. The extension ships no dataset of its own -- QuickStartService runs the image's own /home/documentdb/gateway/scripts/init_documentdb_data.sh against its /home/documentdb/gateway/sample-data directory -- and the wizard defaults to the `latest` tag, so a reader following this page today gets StoreData and none of the four collections named here. Describe what the image actually seeds, point at the sample-data section of the DocumentDB Local page for the detail, and keep the `sampledb` name for anyone deliberately pinning a pre-0.117 tag. Verified against v0.116-0 and v0.117-0 in documentdb/documentdb, and against microsoft/vscode-documentdb at 013e429f.
GuanzhouSong
force-pushed
the
dev/guanzhousong/retired-package-repo-cleanup
branch
from
September 10, 2026 16:30
e810193 to
08f994f
Compare
guanzhousongmicrosoft
approved these changes
Sep 10, 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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
getting-started/prebuilt-packages.mdto lead with the stand-alone setup wizard, and separately document component-level PostgreSQL + gateway workflows, PGDG extension packages, and community/source builds, keeping release-asset installation as reference materialv0.117prefixing), and other small wording issuesContext
The 0.117 page already states that other targets are outside the hosted package matrix, that older packages are not retained, and that existing installations keep running without updates. It stopped short of what an operator on a retired target actually has to do, and nothing in this repo documented the repository cleanup. It also buried the recommended stand-alone install path behind the release-asset instructions, so this restructures the page to lead with it.
The VS Code quick start described a
sampledbdatabase withusers,products,ordersandanalyticscollections. That is the v0.116-0 dataset —documentdb-local/sample-data/held01-users.jsthrough04-analytics.js, each seedingsampledb. v0.117-0 replaces all four with01-store-data.jsplus two gzipped Extended JSON exports, seedingStoreDatawith 41,505storesdocuments and 2ratingsdocuments. The extension ships no dataset of its own —QuickStartServiceruns the image's owninit_documentdb_data.shagainst its bundledsample-datadirectory — and the wizard defaults to thelatesttag, so a reader following that page today got none of the four collections it named.This supersedes #73, which was written against the 0.116 wording that #74 has since rewritten. The parts of #73 that #74 absorbed independently are dropped here, and the
v0.117-0packaging link already onmainis kept rather than reintroducing thev0.116-0one. #73 can be closed.Validation
PACKAGE-INSTALL.mdon documentdb.github.io, shipped in Align website with the v0.116 package matrix documentdb.github.io#164 and still current after the 0.117 pass in #177packaging/build_packages.sh(extension),packaging/gateway/build_gateway_packages.sh(gateway), andpackaging/build_extra_packages.sh(common, tools, stand-alone, meta)packaging/build_packages.shstill acceptsdeb11/deb12/deb13/ubuntu22.04/rhel8and PostgreSQL 15-18, so the build-on-demand path for unhosted targets remains realdocumentdb-local/sample-data/betweenv0.116-0andv0.117-0, againstdocumentdb-local/sample-data/README.mdatv0.117-0, and against microsoft/vscode-documentdb at013e429f