feat(home): offer VS Code alongside Docker in the quick start - #150
Draft
guanzhousongmicrosoft wants to merge 1 commit into
Draft
feat(home): offer VS Code alongside Docker in the quick start#150guanzhousongmicrosoft wants to merge 1 commit into
guanzhousongmicrosoft wants to merge 1 commit into
Conversation
DocumentDB Local shipped in the VS Code extension's 0.10.0 release: the extension now creates and starts the container itself, so someone already working in VS Code no longer needs to run Docker by hand and then type a port, username, password and TLS choice back into a connection wizard. The home page only offered the Docker command, so that path was invisible to the people it was built for -- the ones who arrive at the site without the extension and leave with a terminal command. Docker stays selected by default. It works everywhere and needs nothing beyond Docker itself, while the VS Code path only pays off for people who already live in that editor, so it is offered rather than assumed. The install link comes before the deep link, and neither appears alone. A vscode:// URL for an extension that is not installed does nothing visible at all -- no error, no navigation -- so presenting it on its own would leave a first-time visitor clicking a button that silently does nothing. The heading moves from 'Run locally with Docker' to 'Run DocumentDB locally', since it now covers both. The run-with-docker anchor is kept: nothing in the repository links to it, but it is a public URL and it still lands on the right card. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
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.
What changed
The home page quick start now offers two ways to get DocumentDB running locally, as a toggle: Docker (unchanged, still the default) and VS Code.
The VS Code tab links to the extension on the marketplace and to
vscode://ms-azuretools.vscode-documentdb/local, which opens the DocumentDB Local setup wizard directly.Why
DocumentDB Local shipped in the VS Code extension's 0.10.0 release. The extension now creates and starts the container itself — someone already working in VS Code no longer runs Docker by hand and then types a port, username, password and TLS choice back into a connection wizard.
The home page only offered the Docker command, so that path was invisible to exactly the people it was built for: the ones who arrive here without the extension and leave with a terminal command.
Design notes
vscode://URL for an extension that is not installed does nothing visible at all — no error, no navigation. Presenting it on its own would leave a first-time visitor clicking a button that silently does nothing.run-with-dockeranchor is kept. Nothing in this repository links to it, but it is a public URL and it still lands on the right card.tablist/tab/tabpanelroles, arrow-key navigation between tabs, and rovingtabindexso only the selected tab is in the tab order.Dependency
The deep link needs the action switch added in microsoft/vscode-documentdb#898, which is currently a draft. Before that lands,
vscode://ms-azuretools.vscode-documentdb/localreaches the extension but is rejected — the handler only understood connection-string links.This should not merge before #898 ships in a released version of the extension. Happy to hold it, or to gate the VS Code tab behind a flag if you would rather land the layout first.
Validation
npm run lint,npm test(129 tests) andnpm run build:nextall clean.aria-selected="true"), the VS Code tab isaria-selected="false"withtabindex="-1", and both the deep link and the marketplace link are present.Related, not fixed here
/docs/getting-started/vscode-quickstartstill describes the pre-0.10.0 flow: run Docker first, then add a local connection by hand with port, username, password and a TLS prompt. That is the workflow DocumentDB Local replaced. Worth a follow-up; I left it alone to keep this change to one thing.