Correct Docker and client setup instructions - #75
Merged
guanzhousongmicrosoft merged 1 commit intoSep 10, 2026
Conversation
Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
guanzhousongmicrosoft
approved these changes
Sep 10, 2026
This was referenced Sep 10, 2026
guanzhousongmicrosoft
added a commit
that referenced
this pull request
Sep 10, 2026
The guide only described the manual flow: start the container yourself, then create a New Local Connection and disable TLS. The extension has shipped a guided setup since 0.10.0 that pulls the image, starts the container, waits for readiness, and saves the connection, and the documentdb.io homepage now points people at it. A reader who followed the homepage and then landed here found instructions that contradicted it. Lead with the wizard and give all three ways to open it (Connections view, Command Palette, deep link). Keep the manual path as an explicit alternative for people who run the container themselves; its commands and notes are unchanged from #75, including the loopback binding, the credential prompts, and the network and port notes. Also: - State the real Docker prerequisite, including that Docker must be reachable from the environment VS Code runs in (WSL, dev container, SSH remote, Codespaces). Drop the Git prerequisite, since nothing here clones a repository. - Say what setup produces: container name, persistent volume, generated credentials, and the sampledb collections. - Move creating databases and collections out of the manual path, since both paths need it. - Replace the empty "Common issues and solutions" and "Using the extension logs" stubs with the two failures people actually hit and where the logs are. Verified against microsoft/vscode-documentdb main (013e429f): wizard labels in LocalQuickStart.tsx, the command title in package.json, the deep-link route and its confirmation in vscodeUriHandler.ts, and the container, volume, port, and sample database names in services/localQuickStart/quickStartTypes.ts. The deep link is inline code rather than a link because the site renders these files with react-markdown, which sanitizes non-http(s) URLs. Claude-Session: https://claude.ai/code/session_017dU6YABKoUxKLU2AB1qeH1 Co-authored-by: Guanzhou Song <guanzhousong@microsoft.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
guanzhousongmicrosoft
pushed a commit
to GuanzhouSong/docs
that referenced
this pull request
Sep 10, 2026
Signed-off-by: Guanzhou Song <26541184+GuanzhouSong@users.noreply.github.com>
guanzhousongmicrosoft
pushed a commit
to GuanzhouSong/docs
that referenced
this pull request
Sep 10, 2026
The guide only described the manual flow: start the container yourself, then create a New Local Connection and disable TLS. The extension has shipped a guided setup since 0.10.0 that pulls the image, starts the container, waits for readiness, and saves the connection, and the documentdb.io homepage now points people at it. A reader who followed the homepage and then landed here found instructions that contradicted it. Lead with the wizard and give all three ways to open it (Connections view, Command Palette, deep link). Keep the manual path as an explicit alternative for people who run the container themselves; its commands and notes are unchanged from documentdb#75, including the loopback binding, the credential prompts, and the network and port notes. Also: - State the real Docker prerequisite, including that Docker must be reachable from the environment VS Code runs in (WSL, dev container, SSH remote, Codespaces). Drop the Git prerequisite, since nothing here clones a repository. - Say what setup produces: container name, persistent volume, generated credentials, and the sampledb collections. - Move creating databases and collections out of the manual path, since both paths need it. - Replace the empty "Common issues and solutions" and "Using the extension logs" stubs with the two failures people actually hit and where the logs are. Verified against microsoft/vscode-documentdb main (013e429f): wizard labels in LocalQuickStart.tsx, the command title in package.json, the deep-link route and its confirmation in vscodeUriHandler.ts, and the container, volume, port, and sample database names in services/localQuickStart/quickStartTypes.ts. The deep link is inline code rather than a link because the site renders these files with react-markdown, which sanitizes non-http(s) URLs. Claude-Session: https://claude.ai/code/session_017dU6YABKoUxKLU2AB1qeH1
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
2 participants
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
mongoshflags instead of raw credential URIs.Validation
--passwordflag. Nativedocumentdb-setupuses a prompt/file/stdin; the initialization script uses its password environment variable.Companion change
Website instructions are maintained separately: documentdb/documentdb.github.io#178 fixes those copies and has green CI. Merge this docs PR before the website deployment so imported content is consistent.
The published release note has already been clarified without changing its tag or assets.
AI disclosure
Prepared with GitHub Copilot assistance. Human review and approval are required.