Skip to content

Document the v0.116-0 package layout - #67

Merged
guanzhousongmicrosoft merged 1 commit into
documentdb:mainfrom
GuanzhouSong:docs/prebuilt-packages-0116
Aug 24, 2026
Merged

Document the v0.116-0 package layout#67
guanzhousongmicrosoft merged 1 commit into
documentdb:mainfrom
GuanzhouSong:docs/prebuilt-packages-0116

Conversation

@GuanzhouSong

Copy link
Copy Markdown
Contributor

Problem

getting-started/prebuilt-packages.md still described v0.114-0 throughout: the release link and date, the feature summary, the package matrix, the example filenames, the install commands, and the GHCR tag list — which named pg15/16/17 and said latest aliases pg17-0.114.0.

v0.116-0 also changed the shape of a release, so the page's central claim — that a release publishes one extension package per PostgreSQL major — stopped being true.

Changes

getting-started/prebuilt-packages.md

  • Current release, date, and a note that it also carries the never-published v0.115-0 changes.
  • What ships in a release: the five packages and their roles, and the two version grammars (DEB keeps 0.116-0 for the extension, RPM renders everything as 0.116.0).
  • Package matrix reflecting the Tier-1 build (Ubuntu 24.04 + RHEL-compatible 9, PostgreSQL 17/18), with a pointer to the package repository for the distributions this release did not build.
  • Install commands that work. The packages depend on each other, so installing the meta package alone fails with an unmet documentdb-18 dependency. The commands now pass the whole per-platform set at once.
  • Setup and connectdocumentdb-setup plus mongosh — since installing the packages no longer leaves you one step from an endpoint. Includes that the wizard prompts for a password.
  • A warning that the gateway binds all interfaces by default while the connect example says 127.0.0.1.
  • GHCR tags corrected: adds pg18-0.116.0, and latest now aliases pg17-0.116.0. Verified all five tags exist.
  • Checksum verification via SHA256SUMS.

postgres-api/configuration.md — corrected a claim v0.116-0 invalidated: the packaged gateway service (systemd unit + gateway.env) is now published as a release asset. Also notes that documentdb-setup rebuilds the managed block in gateway.env on re-run.

postgres-api/functions.md — described v0.114-0 as "the current release"; it is now v0.116-0. Reworded to say the page has not yet been revised, rather than silently misstating which release is current.

Verification

  • Frontmatter and navigation.yml link are unchanged, so the page keeps its slug and nav entry.
  • GHCR tags checked with docker manifest inspect: pg15/16/17/18-0.116.0 and latest all exist.
  • Package names, filenames and dependency behaviour were taken from the actual v0.116-0 release assets and verified by installing them.

Related

The pre-built packages page still described v0.114-0: the release link and
date, the feature summary, the package matrix, the example filenames, the
install commands, and the GHCR tag list (which named pg15/16/17 and said
`latest` aliases `pg17-0.114.0`). v0.116-0 also changed the shape of a
release, so the page's central claim -- that a release publishes one extension
package per PostgreSQL major -- was no longer true.

Describe what a release now contains: the five packages and their roles, the
two version grammars, and the Tier-1 matrix (Ubuntu 24.04 and RHEL-compatible 9
on PostgreSQL 17 and 18), with a pointer to the package repository for the
distributions this release did not build.

Give install commands that work. The packages depend on each other, so
installing the meta package alone fails with an unmet `documentdb-18`
dependency; the commands now pass the whole per-platform set at once. Add the
setup wizard and connect steps, since installing the packages no longer leaves
you one step from an endpoint, and note that the gateway binds all interfaces
by default while the connect example says 127.0.0.1.

Also correct two claims elsewhere that v0.116-0 invalidated: the gateway
service IS now published as a release asset, and functions.md described
v0.114-0 as "the current release".

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 8df9084a-ccaf-432c-b015-2ccd8893a9d8
Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
@GuanzhouSong

Copy link
Copy Markdown
Contributor Author

Important context discovered while validating this

documentdb.io does not render this page. The website deliberately supersedes it:

  • app/docs/[section]/[[...slug]]/page.tsx calls redirect('/docs/getting-started/packages') for getting-started/prebuilt-packages
  • splitPrebuiltNavigation() in articleService.ts filters the "Pre-built Packages" entry out of the navigation and substitutes the site's own Docker and Linux Packages quick links

So on the site this content is replaced by an in-repo guide. Verified live: https://documentdb.io/docs/getting-started/prebuilt-packages/ returns 45 characters of body — a Next.js __next_error__ page, because redirect() has no server to run on in a static export.

This PR is therefore still worth merging, but for the repository — not the website. It keeps documentdb/docs accurate for anyone reading it on GitHub or consuming it directly, and it stops the file from being wrong if that redirect is ever removed. The website-facing equivalent is updated separately in documentdb/documentdb.github.io#151.

Two follow-ups for whoever owns the site (not addressed here):

  1. The redirect() renders an error page rather than redirecting, so any bookmark or search result pointing at /docs/getting-started/prebuilt-packages/ is a dead end. A meta-refresh page, or simply rendering the article, would fix it. vscode-extension-guide has the same shape.
  2. Worth deciding deliberately whether this page should be superseded at all, now that its content is current.

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.

2 participants