Skip to content

Update extension documentation steps #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
seesharprun wants to merge 4 commits into from
Closed

Update extension documentation steps #26

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26637ae
DocumentDB VS Code Extension Section (how to connect)
tnaum-ms Aug 20, 2025
fe8bc08
Merge branch 'dev/tnaum/extension' of https://github.com/documentdb/d…
seesharprun Dec 3, 2025
b1fd436
Revert changes to `app\docs\page.tsx`
seesharprun Dec 3, 2025
c8a3bcd
Update extension documentation steps
seesharprun Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions articles/quickstart/extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,16 @@ docker image rm -f ghcr.io/microsoft/documentdb/documentdb-local:latest || echo

### 2. Connecting to your database

- Click the DocumentDB icon in the VS Code sidebar
- Click "Add New Connection"
- On the navigation bar, click on "Connection String"
- Paste your connection string:
- Locate and select the DocumentDB icon in the primary Visual Studio Code sidebar.
- Select "Add New Connection"
- In the DocumentDB "Connections" pane, locate and expand the DocumentDB Local node.
- Select the "New Local Conenction" option.
- Confirm the port (default value 10260), username, password, and choose the Disable TLS/SSL option.
- **NOTE**: TLS/SSL can be enabled, but this walkthrough skips those steps for simplicity.
- A new DocumentDB Local entry will be added and listed in your DocumentDB Connections area.

```
mongodb://<YOUR_USERNAME>:<YOUR_PASSWORD>@localhost:10260/?tls=true&tlsAllowInvalidCertificates=true&authMechanism=SCRAM-SHA-256
```
> [!NOTE]
> Atlernatively, onn the navigation bar, click on "Connection String". Then, paste a variation of this connection string with the `<USERNAME>` and `<PASSWORD>` placeholders modified to values for your cluster: `mongodb://<YOUR_USERNAME>:<YOUR_PASSWORD>@localhost:10260/?tls=true&tlsAllowInvalidCertificates=true&authMechanism=SCRAM-SHA-256`.

### 3. Creating your first database and collection

Expand Down