Skip to content

Raise the Node.js floor to match the driver it tells you to install - #162

Merged
guanzhousongmicrosoft merged 2 commits into
documentdb:mainfrom
GuanzhouSong:users/guanzhousong/rereview-fixes
Aug 25, 2026
Merged

Raise the Node.js floor to match the driver it tells you to install#162
guanzhousongmicrosoft merged 2 commits into
documentdb:mainfrom
GuanzhouSong:users/guanzhousong/rereview-fixes

Conversation

@GuanzhouSong

Copy link
Copy Markdown
Contributor

The Node.js quick start listed:

  • Node.js 18 or later

as its prerequisite, and then ran an unpinned npm install mongodb. The current driver requires Node >=20.19, so a reader who satisfies the documented prerequisite fails at install time with an engine error.

Found by the second review pass. The same floor was corrected in documentdb/docs; this is the website-owned copy of the same page, which was missed because the two live in different content layers — the docs repo is cloned at build time, while this page is a TypeScript template literal in articleService.ts.

npm test 130 passed · tsc --noEmit clean.

Related

documentdb/docs#72 — the docs-repo half, plus two samples broken by the previous fix round.

The Node.js quick start listed 'Node.js 18 or later' as its prerequisite
and then ran an unpinned 'npm install mongodb'. The current driver
requires Node >=20.19, so a reader on 18 satisfies the documented
prerequisite and then fails at install time with an engine error.

The same floor was corrected in documentdb/docs; this is the website-owned
copy of the same page.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: f18515db-c52f-4197-aa50-d81359c7c763
Signed-off-by: Guanzhou Song <guanzhou.song@gmail.com>
Two findings from the second review pass, both verified against the
shipped image.

The Docker troubleshooting list and the getting-started index both told
readers to restart with --log-level debug for more detail. The site's own
DocumentDB Local page documents that flag as a known issue: the value is
validated at startup but does not change what the container logs, and
DOCUMENTDB_LOG_LEVEL is the control that works. The advice was also
impossible as written for a second reason -- docker restart cannot change
a container's arguments or environment. Point at the env var and say the
container has to be re-created.

The previous round corrected the sample-data claim on the Docker and
mongosh guides but left the Python and VS Code guides saying 'if you
started with DocumentDB Local sample data'. Neither page's docker run
includes --init-data true, so that condition is never true for someone
following those pages, and the reader is left unsure whether an empty
result is a mistake. State that it is opt-in, as the other two guides now
do.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: f18515db-c52f-4197-aa50-d81359c7c763
Signed-off-by: Guanzhou Song <guanzhou.song@gmail.com>
@guanzhousongmicrosoft
guanzhousongmicrosoft merged commit 9463123 into documentdb:main Aug 25, 2026
2 checks passed
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