diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 38dcad8ff..adbfa0a26 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,6 +1,6 @@ # GitHub Copilot Instructions for vscode-documentdb -VS Code Extension for Azure Cosmos DB and the MongoDB API. TypeScript (strict mode), React webviews, Vitest testing. +The DocumentDB extension for Visual Studio Code: a DocumentDB and MongoDB GUI for Azure DocumentDB, DocumentDB and MongoDB. TypeScript (strict mode), React webviews, Vitest testing. ## Critical Build Commands @@ -278,6 +278,21 @@ This is a **DocumentDB** extension that uses the **MongoDB-compatible wire proto This applies to: code comments, JSDoc/TSDoc, naming (prefer `documentdb` prefix), user-facing strings, docs, and test descriptions. +### Product name + +The extension is the **DocumentDB extension for Visual Studio Code** (was "DocumentDB for VS Code", see #1024). + +| Where | Name to use | +| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | +| README, docs, release notes, blog posts, announcements, Marketplace listing (title and first mention) | **DocumentDB extension for Visual Studio Code** | +| Later mentions in the same text | "the extension" or "the DocumentDB extension" | +| In-product UI (`displayName`, output channel, walkthrough, notifications, view and command titles) | **DocumentDB**, or "the DocumentDB extension" where it could be confused with the database | +| Running text | "VS Code" is fine, for example "without leaving VS Code" | + +- Keep UI strings short: never put the full product name in a notification, quick pick, tree item or webview. +- Never write "DocumentDB for VS Code" as a product name in new content. +- Unchanged: the extension ID `ms-azuretools.vscode-documentdb`, the repo slug `vscode-documentdb`, URLs, and historical content (0.x release notes, `CHANGELOG.md`, `docs/ai-and-plans/**`). + ## TDD Contract Tests Test suites prefixed with `TDD:` (e.g., `describe('TDD: Completion Behavior', ...)`) are **behavior contracts** written before the implementation. If a `TDD:` test fails after a code change: diff --git a/.github/skills/documentation-screenshots/SKILL.md b/.github/skills/documentation-screenshots/SKILL.md index 18d7de37a..39e97c7b6 100644 --- a/.github/skills/documentation-screenshots/SKILL.md +++ b/.github/skills/documentation-screenshots/SKILL.md @@ -1,6 +1,6 @@ --- name: documentation-screenshots -description: Frames and annotates DocumentDB for VS Code screenshots for release notes, documentation and blog posts, so every image shares one visual style (brand background, Fluent 2 shadow, rounded corners, consistent text size), in a light theme for this repo or a dark theme for dark sites such as documentdb.io. Use when adding or replacing screenshots in docs/release-notes, docs/user-manual or docs/blog-posts, when preparing images for the documentdb.io blog, when the operator provides raw captures, or when asked to frame, beautify, annotate (numbered steps, arrows) or unify images. +description: Frames and annotates screenshots of the DocumentDB extension for Visual Studio Code for release notes, documentation and blog posts, so every image shares one visual style (brand background, Fluent 2 shadow, rounded corners, consistent text size), in a light theme for this repo or a dark theme for dark sites such as documentdb.io. Use when adding or replacing screenshots in docs/release-notes, docs/user-manual or docs/blog-posts, when preparing images for the documentdb.io blog, when the operator provides raw captures, or when asked to frame, beautify, annotate (numbered steps, arrows) or unify images. --- # Documentation and Release Notes Screenshots diff --git a/.github/skills/documentation-screenshots/scripts/frame.py b/.github/skills/documentation-screenshots/scripts/frame.py index 187b7f84d..2e5674af3 100644 --- a/.github/skills/documentation-screenshots/scripts/frame.py +++ b/.github/skills/documentation-screenshots/scripts/frame.py @@ -1,5 +1,5 @@ """ -DocumentDB for VS Code screenshot framing tool. +Screenshot framing tool for the DocumentDB extension for Visual Studio Code. Frames tool screenshots in the DocumentDB release-notes style: - brand background: pale blue -> cyan gradient with a subtle dot grid diff --git a/.github/skills/writing-release-notes/ANNOUNCING-ON-DISCUSSIONS.md b/.github/skills/writing-release-notes/ANNOUNCING-ON-DISCUSSIONS.md new file mode 100644 index 000000000..ff838bf31 --- /dev/null +++ b/.github/skills/writing-release-notes/ANNOUNCING-ON-DISCUSSIONS.md @@ -0,0 +1,107 @@ +# Announcing a Release on GitHub Discussions + +Every release is announced in the **Announcements** category of +[GitHub Discussions](https://github.com/microsoft/vscode-documentdb/discussions). The body always comes +from `docs/release-notes/X.Y.md`, so write and commit the release notes first. + +| Version type | What to post | Title | +| ---------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | +| Major or minor (X.Y.0) | One new discussion with the whole release notes file | `DocumentDB extension for Visual Studio Code vX.Y Released! ` | +| Patch (X.Y.Z, Z > 0) | 1. A new discussion with the patch section
2. Then the same text as a comment on the X.Y.0 announcement, in that order | `Patch Release vX.Y.Z ๐Ÿ“Ž` (the ๐Ÿ“Ž emoji is part of the title) | + +## Patch release: post, then comment + +The order matters. Discussions sorts Announcements by most recent activity, so the X.Y.0 announcement +must receive its comment **after** the patch discussion is created. That keeps the main release +announcement on top, with the patch post right below it. + +1. **Extract the patch section** from the release notes. It starts at `## Patch Release vX.Y.Z` and + ends before the next `---` separator (or at the end of the file). Use it as is, heading included: + + ```bash + awk '/^## Patch Release vX.Y.Z$/{p=1} p&&/^---$/{exit} p' docs/release-notes/X.Y.md > patch-body.md + ``` + +2. **Create the patch discussion** in Announcements, titled `Patch Release vX.Y.Z ๐Ÿ“Ž`: + + ```bash + gh api graphql -f query=' + { + repository(owner: "microsoft", name: "vscode-documentdb") { + id + discussionCategories(first: 20) { nodes { id name } } + } + }' + + gh api graphql -f query=' + mutation($repo: ID!, $cat: ID!, $title: String!, $body: String!) { + createDiscussion(input: {repositoryId: $repo, categoryId: $cat, title: $title, body: $body}) { + discussion { url } + } + }' -f repo= -f cat= -f title="Patch Release vX.Y.Z ๐Ÿ“Ž" \ + -F body=@patch-body.md --jq '.data.createDiscussion.discussion.url' + ``` + +3. **Find the X.Y.0 announcement** for the version being patched. Do not assume it is the discussion + that `releaseNotesUrl` in `package.json` points to: that is the announcement of the newest minor + release, and a patch can target an older version (for example 1.0.2 shipped from a + `release/1.0.2` branch while `main` is on 1.1). Look it up by title and check its content: + + ```bash + gh api graphql -f query=' + query($cat: ID!) { + repository(owner: "microsoft", name: "vscode-documentdb") { + discussions(categoryId: $cat, first: 100) { + nodes { number id title url body } + } + } + }' -f cat= --jq '.data.repository.discussions.nodes[] + | select(.title | contains("vX.Y Released")) + | {number, id, title, url, heading: (.body | split("\n") | map(select(startswith("# "))) | first)}' + ``` + + - The title must contain `vX.Y Released`. Older titles use the retired product name (for example + "DocumentDB for VS Code v0.7 Released! ๐Ÿฆˆ"), so match on the version, not on the name. The + trailing space keeps `v0.1` from matching `v0.11`. + - The `heading` (the first `# ` line of the body) must name the same `vX.Y` and must not be a + patch heading. Compare a paragraph of the body with the opening of `docs/release-notes/X.Y.md` + if in doubt. + - Use the result only if exactly one discussion passes both checks. If none or several do, stop and + ask the operator which discussion to use. Never fall back to `releaseNotesUrl` silently. + - If Announcements ever holds more than 100 discussions, page through them with `pageInfo` and + `after`. + +4. **Comment on that announcement** with the same text, using the `id` from the lookup: + + ```bash + gh api graphql -f query=' + mutation($id: ID!, $body: String!) { + addDiscussionComment(input: {discussionId: $id, body: $body}) { comment { url } } + }' -f id= -F body=@patch-body.md --jq '.data.addDiscussionComment.comment.url' + ``` + +5. Check that the Announcements list shows the X.Y.0 announcement first and the patch discussion second. + +## Major or minor release + +1. Create the discussion in Announcements with the release notes body (everything after the front + matter, `sed '1,/^---$/d' docs/release-notes/X.Y.md`, read with `-F body=@file`), titled + `DocumentDB extension for Visual Studio Code vX.Y Released! `. Pick one emoji that fits the + release. +2. Copy the discussion URL into `releaseNotesUrl` in `package.json`, so users reach the announcement + from inside the extension. +3. Pin the new announcement and unpin the previous one. The API cannot pin discussions; use the + **Pin discussion** and **Unpin discussion** actions on the discussion page. + +## Things to know + +- **Pass long bodies from a file.** Use `-F body=@file.md`. Passing the text inline can exceed the + command-line length limit on Windows. +- **Images need absolute URLs.** Relative paths such as `./images/X.Y.Z_feature.png` do not render in + Discussions. Upload each image by dragging it into any Discussions comment box (do not submit the + comment), copy the generated `https://github.com/user-attachments/assets/...` URL, and replace the + relative path in the body. There is no API for these uploads. +- **Keep `` light and dark pairs.** Upload both variants and set `srcset` and `src` to the two + uploaded URLs. +- **Edit with `updateDiscussion`** (title and body) when the post needs a fix later. Keep the release + notes file and the discussion text in sync. diff --git a/.github/skills/writing-release-notes/EXAMPLES-MAJOR-RELEASE.md b/.github/skills/writing-release-notes/EXAMPLES-MAJOR-RELEASE.md index 538625fc6..2b3b82b13 100644 --- a/.github/skills/writing-release-notes/EXAMPLES-MAJOR-RELEASE.md +++ b/.github/skills/writing-release-notes/EXAMPLES-MAJOR-RELEASE.md @@ -13,9 +13,9 @@ parent: 'Release Notes' nav_order: NNNN --- -# DocumentDB for VS Code Extension vX.Y +# DocumentDB extension for Visual Studio Code vX.Y -We are excited to announce the release of **DocumentDB for VS Code Extension vX.Y**. This is a landmark update for our DocumentDB and MongoDB GUI, focused on [primary theme]. It introduces [headline feature], enhances [secondary improvement], and improves [third improvement] for developers working with DocumentDB and MongoDB API databases. +We are excited to announce the release of **version X.Y of the DocumentDB extension for Visual Studio Code**. This is a landmark update for our DocumentDB and MongoDB GUI, focused on [primary theme]. It introduces [headline feature], enhances [secondary improvement], and improves [third improvement] for developers working with DocumentDB and MongoDB API databases. ## What's New in vX.Y @@ -64,6 +64,8 @@ See the full changelog entry for this release: ## Real Example (v0.6.0) +Historical example: it uses the retired name "DocumentDB for VS Code". Use the template above for the product name. + ```markdown --- title: 'v0.6' diff --git a/.github/skills/writing-release-notes/RELEASE-NOTES-FORMAT.md b/.github/skills/writing-release-notes/RELEASE-NOTES-FORMAT.md index 7dfc49e18..55f66edf0 100644 --- a/.github/skills/writing-release-notes/RELEASE-NOTES-FORMAT.md +++ b/.github/skills/writing-release-notes/RELEASE-NOTES-FORMAT.md @@ -33,7 +33,7 @@ Patch releases append to the existing file and do not change the front matter. ### Main Release Section (X.Y.0) ```markdown -# DocumentDB for VS Code Extension vX.Y +# DocumentDB extension for Visual Studio Code vX.Y Opening paragraph expressing excitement about the release. Summarize 2-3 key highlights. Mention the extension name and target audience (developers working with DocumentDB/MongoDB). @@ -91,24 +91,28 @@ See the full changelog entry for this release: ## Writing Style +### Product Name + +The extension is the **DocumentDB extension for Visual Studio Code**. Use the full name in the title and the first mention, then "the extension". "VS Code" is fine in running text. Never use the retired name "DocumentDB for VS Code" in new release notes; it still appears in the real 0.x examples below because those notes are historical. See [Product name](../../copilot-instructions.md#product-name). + ### Opening Paragraph Patterns **For Major Features:** ```markdown -We are excited to announce the release of **DocumentDB for VS Code Extension vX.Y**. This is a landmark update for our DocumentDB and MongoDB GUI, focused on [theme]. It introduces [major feature], enhances [improvement area], and improves [another area] for developers working with DocumentDB and MongoDB API databases. +We are excited to announce the release of **version X.Y of the DocumentDB extension for Visual Studio Code**. This is a landmark update for our DocumentDB and MongoDB GUI, focused on [theme]. It introduces [major feature], enhances [improvement area], and improves [another area] for developers working with DocumentDB and MongoDB API databases. ``` **For Incremental Updates:** ```markdown -We are excited to announce the release of **DocumentDB for VS Code Extension vX.Y**. This update significantly enhances [area] with [improvement], introduces [feature], and delivers several key bug fixes to improve stability and user experience. +We are excited to announce the release of **version X.Y of the DocumentDB extension for Visual Studio Code**. This update significantly enhances [area] with [improvement], introduces [feature], and delivers several key bug fixes to improve stability and user experience. ``` **For Initial/Foundation Releases:** ```markdown -We're happy to announce the **public release of the DocumentDB for VS Code Extension (vX.Y)**, a dedicated VS Code extension designed specifically for developers working with **DocumentDB** and **MongoDB** databases. +We're happy to announce the **public release of the DocumentDB extension for Visual Studio Code (vX.Y)**, a dedicated VS Code extension designed specifically for developers working with **DocumentDB** and **MongoDB** databases. ``` ### Feature Description Patterns diff --git a/.github/skills/writing-release-notes/SKILL.md b/.github/skills/writing-release-notes/SKILL.md index 095ba5b67..599c9ec07 100644 --- a/.github/skills/writing-release-notes/SKILL.md +++ b/.github/skills/writing-release-notes/SKILL.md @@ -1,11 +1,13 @@ --- name: writing-release-notes -description: Generates release notes and changelog entries for the DocumentDB VS Code extension. Use when preparing version releases, creating patch update notes, writing changelog entries, or documenting new features and fixes. Handles both major/minor versions (new file) and patch updates (append to existing file). +description: Generates release notes and changelog entries for the DocumentDB extension for Visual Studio Code, and announces releases on GitHub Discussions. Use when preparing version releases, creating patch update notes, writing changelog entries, documenting new features and fixes, or posting a release or patch release announcement to Discussions. Handles both major/minor versions (new file) and patch updates (append to existing file). --- # Writing Release Notes and Changelog -Generate professional release documentation for the DocumentDB VS Code extension. +Generate professional release documentation for the DocumentDB extension for Visual Studio Code. + +Product name: use **DocumentDB extension for Visual Studio Code** in titles and first mentions, then "the extension". The old name "DocumentDB for VS Code" is retired; see [Product name](../../copilot-instructions.md#product-name). ## When to Use @@ -13,6 +15,7 @@ Generate professional release documentation for the DocumentDB VS Code extension - Appending patch release notes (X.Y.Z where Z > 0) - Writing changelog entries for any version - Documenting new features, improvements, or fixes +- Announcing a release or patch release on GitHub Discussions ## Quick Reference @@ -102,6 +105,20 @@ Version X.Y.Z: 4. For X.Y.Z (patch): Append `, [X.Y.Z](./release-notes/X.Y#patch-release-vXYZ)` to the existing line for that major.minor version (where `vXYZ` uses no dots, e.g., `v071`) 5. Follow the existing pattern of other entries in the list +### Step 6: Announce on GitHub Discussions + +Once the release notes are committed, post the announcement in the **Announcements** category. Follow +[ANNOUNCING-ON-DISCUSSIONS.md](./ANNOUNCING-ON-DISCUSSIONS.md) for the commands and the image handling. + +- **X.Y.0:** one new discussion, titled `DocumentDB extension for Visual Studio Code vX.Y Released! `, + with the release notes as the body. Point `releaseNotesUrl` in `package.json` at it and pin it. +- **X.Y.Z (patch):** first create a new discussion titled `Patch Release vX.Y.Z ๐Ÿ“Ž` whose body is the + `## Patch Release vX.Y.Z` section; then post the same text as a comment on the X.Y.0 announcement. + Find that announcement by title (`vX.Y Released`) and content, not through `releaseNotesUrl`: a + patch can target an older version. If the lookup is not a single clear match, ask the operator. + Keep this order: it puts the X.Y.0 announcement first and the patch post second in the + recently updated Announcements list. + ## Writing Guidelines ### Changelog Tone @@ -146,3 +163,4 @@ Before completing: - [ ] `docs/index.md` Release Notes section updated with link to new version - [ ] Screenshot question was answered - [ ] Every requested screenshot is framed with [documentation-screenshots](../documentation-screenshots/SKILL.md), saved under `docs/release-notes/images/` and referenced +- [ ] Announcement posted per [ANNOUNCING-ON-DISCUSSIONS.md](./ANNOUNCING-ON-DISCUSSIONS.md) (for a patch: new `Patch Release vX.Y.Z ๐Ÿ“Ž` discussion first, then the same text as a comment on the X.Y.0 announcement) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3bb26cdcd..af5ea5ef3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log +## 1.0.1 + +### Improvements + +- **New Name**: The extension is now the DocumentDB extension for Visual Studio Code. The product UI, walkthrough, settings group and output channel use the short name DocumentDB; the extension ID, settings and commands are unchanged. [#1024](https://github.com/microsoft/vscode-documentdb/issues/1024), [#1027](https://github.com/microsoft/vscode-documentdb/issues/1027), [#1035](https://github.com/microsoft/vscode-documentdb/pull/1035) +- **Documentation**: Updates the README, user manual and documentation site header to the new name, and adds product name guidance for contributors and agents. [#1025](https://github.com/microsoft/vscode-documentdb/issues/1025), [#1029](https://github.com/microsoft/vscode-documentdb/issues/1029), [#1030](https://github.com/microsoft/vscode-documentdb/issues/1030), [#1035](https://github.com/microsoft/vscode-documentdb/pull/1035) + ## 1.0.0 ### New Features diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e9db30d7..e8f9bec79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,8 @@ -# Contributing to DocumentDB for VS Code +# Contributing to the DocumentDB extension for Visual Studio Code -Thank you for your interest in contributing to the **DocumentDB for VS Code** extension. This guide helps you set up your development environment and configure Visual Studio Code to effectively contribute to the extension. +Thank you for your interest in contributing to the **DocumentDB extension for Visual Studio Code**. This guide helps you set up your development environment and configure Visual Studio Code to effectively contribute to the extension. + +> **Product name:** in docs and announcements, use **DocumentDB extension for Visual Studio Code** on first mention, then "the extension". In the product UI, the extension is just **DocumentDB**. The old name "DocumentDB for VS Code" is retired. See [Product name](.github/copilot-instructions.md#product-name) for the full rule. The document consists of seven sections: @@ -175,14 +177,14 @@ npm install -g typescript ## 3. VS Code Configuration -This section explains how to clone the **DocumentDB for VS Code** repository and set up Visual Studio Code for development and debugging. +This section explains how to clone the **DocumentDB extension for Visual Studio Code** repository and set up Visual Studio Code for development and debugging. ### 3.1. Steps to Clone and Set Up Repository 1. Ensure you have completed the [Machine Setup](#2-machine-setup) steps. 2. Fork or directly clone the official repository: - - [DocumentDB for VS Code (vscode-documentdb)](https://github.com/microsoft/vscode-documentdb) + - [DocumentDB extension for Visual Studio Code (vscode-documentdb)](https://github.com/microsoft/vscode-documentdb) - Open your **WSL2** terminal and clone the repository: @@ -397,35 +399,12 @@ Running `npm install` here is required: bumping `package.json` alone leaves the ### 7.5 Create the announcement discussion -Based on the `docs/release-notes/X.Y.md` file, create a new discussion under **Discussions** on the GitHub repo. This is the user-facing announcement for the release. - -An agent can create it for you. GitHub's REST API has no endpoint for discussions, so this goes through GraphQL. First look up the repository ID and the category you want: - -```bash -gh api graphql -f query=' -{ - repository(owner: "microsoft", name: "vscode-documentdb") { - id - discussionCategories(first: 20) { nodes { id name } } - } -}' -``` - -Then create the discussion, using the release-notes body: - -```bash -gh api graphql -f query=' -mutation($repo: ID!, $cat: ID!, $title: String!, $body: String!) { - createDiscussion(input: {repositoryId: $repo, categoryId: $cat, title: $title, body: $body}) { - discussion { url } - } -}' -f repo= -f cat= -f title="vX.Y.Z" -f body="$(sed '1,/^---$/d' docs/release-notes/X.Y.md)" \ - --jq '.data.createDiscussion.discussion.url' -``` +Based on the `docs/release-notes/X.Y.md` file, announce the release in the **Announcements** category of **Discussions** on the GitHub repo. This is the user-facing announcement for the release. -The mutation returns the discussion URL, which is what the next paragraph needs. +An agent can do this for you with the `writing-release-notes` skill. The full commands, including how to handle images, are in [ANNOUNCING-ON-DISCUSSIONS.md](.github/skills/writing-release-notes/ANNOUNCING-ON-DISCUSSIONS.md). -If this is **more than a patch release** (a new minor or major, `X.Y.0`), copy that URL into the `releaseNotesUrl` field in `package.json` so users see the announcement from inside the extension. For a plain patch release, leave `releaseNotesUrl` pointing at the current minor's announcement. +- **Minor or major release (`X.Y.0`):** create one new discussion titled `DocumentDB extension for Visual Studio Code vX.Y Released! ` with the release notes as the body. Copy its URL into the `releaseNotesUrl` field in `package.json` so users see the announcement from inside the extension, then pin it in place of the previous announcement. +- **Patch release (`X.Y.Z`):** first create a new discussion titled `Patch Release vX.Y.Z ๐Ÿ“Ž` whose body is the `## Patch Release vX.Y.Z` section of the release notes. Then post the same text as a comment on the `X.Y.0` announcement of the version being patched. Find that announcement by its title (`vX.Y Released`) and check its content; do not assume it is the one `releaseNotesUrl` points to, because a patch can target an older version. Keep this order: Announcements are listed by most recent activity, so the comment brings the `X.Y.0` announcement back to the top with the patch post right below it. Leave `releaseNotesUrl` unchanged. ### 7.6 Commit the version bump @@ -450,4 +429,4 @@ Run the second internal Azure DevOps pipeline, the **release** pipeline, which p ## You're Ready to Contribute! ๐ŸŽ‰ -You've now successfully set up your development environment and are ready to contribute to **DocumentDB for VS Code**. We appreciate your contributions! +You've now successfully set up your development environment and are ready to contribute to the **DocumentDB extension for Visual Studio Code**. We appreciate your contributions! diff --git a/README.md b/README.md index 9ae3b999f..4c3f61a6b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# DocumentDB for VS Code +# DocumentDB extension for Visual Studio Code @@ -7,7 +7,7 @@ DocumentDB Logo -> **Built in the open, with you.** DocumentDB for VS Code is open source under the MIT license. The roadmap, the design discussions and every change happen right here on GitHub. +> **Built in the open, with you.** The DocumentDB extension for Visual Studio Code is open source under the MIT license. The roadmap, the design discussions and every change happen right here on GitHub. > > - โฌ‡๏ธ **Install it** from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-documentdb), or search for "DocumentDB" in the VS Code Extensions view > - ๐Ÿ’ฌ **Have a question or an idea?** Join the conversation in [GitHub Discussions](https://github.com/microsoft/vscode-documentdb/discussions) @@ -28,7 +28,7 @@ Connect to your databases, explore your data, run and tune queries, and move col ๐ŸŽ‰ **Version 1.0 is here**, released alongside DocumentDB 1.0. See [what's in 1.0](https://microsoft.github.io/vscode-documentdb/release-notes/1.0). -

DocumentDB for VS Code: the Collection View with a query, autocompletion and results in a table

+

DocumentDB extension for Visual Studio Code: the Collection View with a query, autocompletion and results in a table

## Connect in Seconds, Wherever Your Data Lives @@ -113,7 +113,7 @@ This project may contain trademarks or logos for projects, products, or services ## Designed for Every Theme -DocumentDB for VS Code feels at home in your workspace, whether you prefer a light or dark theme. +The extension feels at home in your workspace, whether you prefer a light or dark theme.

DocumentDB logo

@@ -127,7 +127,7 @@ VS Code collects usage data and sends it to Microsoft to help improve our produc # Feedback Collection -DocumentDB for VS Code proactively asks for user feedback and provides feedback entry points in the UI. Feedback collection follows VS Code's `telemetry.feedback.enabled` setting, which organizations can also enforce through the `EnableFeedback` policy. +The extension proactively asks for user feedback and provides feedback entry points in the UI. Feedback collection follows VS Code's `telemetry.feedback.enabled` setting, which organizations can also enforce through the `EnableFeedback` policy. To disable feedback, set `telemetry.feedback.enabled` to `false`. This hides the survey invitation, the in-product feedback buttons, and the **DocumentDB: Give Feedback** command. Telemetry about the survey is additionally subject to `telemetry.telemetryLevel`. diff --git a/api/src/utils/getApi.ts b/api/src/utils/getApi.ts index cea11f0e7..639330535 100644 --- a/api/src/utils/getApi.ts +++ b/api/src/utils/getApi.ts @@ -27,7 +27,7 @@ function isValidPackageJson(packageJson: unknown): packageJson is DocumentDBApiC } /** - * Gets the DocumentDB for VS Code extension API + * Gets the DocumentDB extension API * * NOTE: This is an experimental implementation. Extensions using this API are whitelisted * as a safeguard during the experimental phase. This safeguard will be removed once the @@ -69,14 +69,14 @@ export async function getDocumentDBExtensionApi( : undefined; if (!registeredClients || !Array.isArray(registeredClients)) { - throw new Error(`DocumentDB for VS Code API configuration is invalid. No registered clients found.`); + throw new Error(`DocumentDB extension API configuration is invalid. No registered clients found.`); } if (!registeredClients.includes(callingExtensionId)) { throw new Error( - `Extension '${callingExtensionId}' is not authorized to use the DocumentDB for VS Code API. ` + + `Extension '${callingExtensionId}' is not authorized to use the DocumentDB extension API. ` + `This is an experimental API with whitelisted access. ` + - `Please reach out to the DocumentDB for VS Code extension team to request access.`, + `Please reach out to the DocumentDB extension team to request access.`, ); } diff --git a/build/verification/activation/activation.test.cjs b/build/verification/activation/activation.test.cjs index ada5f66a6..86c329b4c 100644 --- a/build/verification/activation/activation.test.cjs +++ b/build/verification/activation/activation.test.cjs @@ -48,7 +48,7 @@ function temporaryDirectory(context) { } /** @param {string} text @param {string} [file] @returns {ReturnType} */ -function recognized(text, file = 'logs/exthost1/output_logging/1-DocumentDB for VS Code.log') { +function recognized(text, file = 'logs/exthost1/output_logging/1-DocumentDB.log') { return recognizeLogs( [ { file: 'logs/exthost1/exthost.log', contents: '2026-10-01 12:00:00 [info] Extension host started' }, @@ -234,7 +234,7 @@ test('captured successful-run teardown retains the real SchemaStore disposed-cha [ { file: 'exthost.log', contents: host }, { - file: 'DocumentDB for VS Code.log', + file: 'DocumentDB.log', contents: '2026-10-02 06:59:46.280 [info] Showing welcome screen...', }, ], @@ -547,7 +547,7 @@ module.exports.activate = async function () { `2026-10-01 12:00:00 [info] Activated ${TARGET_ID}\n2026-10-01 12:00:01 [error] vscode.git unrelated failure`, ); fs.writeFileSync( - path.join(logs, 'output_logging/1-DocumentDB for VS Code.log'), + path.join(logs, 'output_logging/1-DocumentDB.log'), output.length ? output.map((message) => `2026-10-01 12:00:01 [info] ${message}`).join('\n') : '2026-10-01 12:00:01 [info] Showing welcome screen...', @@ -675,7 +675,7 @@ test('proof rejects absent marker and unrelated DocumentDB failures, not just ar unrelated.dependencies.logs = (userDataDir, installed) => { const report = inspectUnrelated(userDataDir, installed); report.errors.push({ - file: 'DocumentDB for VS Code.log', + file: 'DocumentDB.log', line: 2, text: 'Error: another initialization failure', }); diff --git a/build/verification/activation/checks.cjs b/build/verification/activation/checks.cjs index b94a77071..6e644ed97 100644 --- a/build/verification/activation/checks.cjs +++ b/build/verification/activation/checks.cjs @@ -153,7 +153,8 @@ function recognizeLogs(logs, installedPath) { for (const log of logs) { const basename = path.basename(log.file); const host = /^exthost(?:\.\d+)?\.log$/i.test(basename); - const output = /documentdb.*(?:for.*vs.*code|query.*playground).*\.log$/i.test(basename); + // Output channel logs are named "-.log": the main "DocumentDB" channel and the playground output. + const output = /^(?:\d+-)?documentdb(?: query playground.*)?\.log$/i.test(basename); if (!host && !output) { continue; } diff --git a/docs/_config.yml b/docs/_config.yml index a8a8de9ad..671632bbe 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -3,8 +3,8 @@ # How it works and how to preview it: ai-and-plans/features/docs-site/README.md remote_theme: just-the-docs/just-the-docs@v0.12.0 -title: DocumentDB for VS Code -description: Learn more about the DocumentDB for VS Code Extension +title: DocumentDB extension for Visual Studio Code +description: Learn more about the DocumentDB extension for Visual Studio Code, an open-source DocumentDB GUI and MongoDB GUI. baseurl: '/vscode-documentdb' url: 'https://microsoft.github.io' diff --git a/docs/_includes/title.html b/docs/_includes/title.html index b85051cac..40f0d0a93 100644 --- a/docs/_includes/title.html +++ b/docs/_includes/title.html @@ -1,9 +1,2 @@ -{%- comment -%} - Overrides the theme's title.html: DocumentDB icon next to the site title. - The source swaps to the dark-background icon when the OS prefers dark. -{%- endcomment -%} - - - - -{{ site.title | replace: ' for VS Code', ' for VS Code' }} +DocumentDB +extension for Visual Studio Code diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss index 3ee520c61..946bc2ec7 100644 --- a/docs/_sass/custom/custom.scss +++ b/docs/_sass/custom/custom.scss @@ -20,32 +20,38 @@ h3, letter-spacing: normal; } -.site-title { - font-weight: 600; +.site-header { + height: auto; + min-height: 5.5rem; } -// Sidebar title with the DocumentDB icon (see _includes/title.html). .site-title { display: flex; - align-items: center; - gap: 0.625rem; + flex: 1; + flex-direction: column; + align-items: flex-start; + justify-content: center; + gap: 0.25rem; + min-width: 0; + padding-top: 0.75rem; + padding-bottom: 0.75rem; + font-size: 1.25rem !important; + font-weight: 600; + white-space: normal; } -.site-icon { - display: flex; - flex: none; +.site-title-name { + line-height: 1.2; +} - img { - width: 1.75rem; - height: auto; - } +.site-title-subtitle { + font-size: 0.75rem; + font-weight: 400; + line-height: 1.4; } -// The theme sets 1.5rem !important from 31.25rem up; keep the title on one line next to the icon. -@media (min-width: 31.25rem) { - .site-title { - font-size: 1.25rem !important; - } +.site-title-editor { + white-space: nowrap; } // "On this page" panel (assets/js/page-toc.js). diff --git a/docs/blog-posts/2026-10-release-1.0/images/1.0.0_hero.png b/docs/blog-posts/2026-10-release-1.0/images/1.0.0_hero.png index 82acd0c17..6cb665263 100644 Binary files a/docs/blog-posts/2026-10-release-1.0/images/1.0.0_hero.png and b/docs/blog-posts/2026-10-release-1.0/images/1.0.0_hero.png differ diff --git a/docs/blog-posts/2026-10-release-1.0/images/1.0.0_hero_dark.png b/docs/blog-posts/2026-10-release-1.0/images/1.0.0_hero_dark.png index 35db1bca4..424661a87 100644 Binary files a/docs/blog-posts/2026-10-release-1.0/images/1.0.0_hero_dark.png and b/docs/blog-posts/2026-10-release-1.0/images/1.0.0_hero_dark.png differ diff --git a/docs/blog-posts/2026-10-release-1.0/index.md b/docs/blog-posts/2026-10-release-1.0/index.md index 04d745e8d..b3f0ec916 100644 --- a/docs/blog-posts/2026-10-release-1.0/index.md +++ b/docs/blog-posts/2026-10-release-1.0/index.md @@ -1,14 +1,14 @@ -# DocumentDB for VS Code 1.0: Run It Locally, Bring Your Data +# DocumentDB Extension for Visual Studio Code 1.0: Run It Locally, Bring Your Data -> Also published on the DocumentDB blog at documentdb.io: tracked in [documentdb/documentdb.github.io#214](https://github.com/documentdb/documentdb.github.io/pull/214). Keep both versions in sync. +> Also published on the DocumentDB blog at documentdb.io: tracked in [documentdb/documentdb.github.io#214](https://github.com/documentdb/documentdb.github.io/pull/214) and [#226](https://github.com/documentdb/documentdb.github.io/pull/226). Keep both versions in sync. -_October 19, 2026, by Tomasz Naumowicz and the DocumentDB for VS Code team_ +_October 19, 2026, by Tomasz Naumowicz and the team behind the DocumentDB extension for Visual Studio Code_ -_The free, open-source DocumentDB GUI for VS Code reaches 1.0. Start DocumentDB Local in a few clicks, bring your data with copy and paste, and understand it with the Cluster Dashboard and Query Insights._ +_The DocumentDB extension for Visual Studio Code, a free, open-source DocumentDB GUI, reaches 1.0. Start DocumentDB Local in a few clicks, bring your data with copy and paste, and understand it with the Cluster Dashboard and Query Insights._ -

DocumentDB for VS Code 1.0

+

DocumentDB extension for Visual Studio Code 1.0

-DocumentDB for VS Code 1.0 is here. Released alongside [DocumentDB 1.0](https://documentdb.io/), the free, open-source extension is a **DocumentDB GUI** and MongoDB GUI, built right into Visual Studio Code. It works with DocumentDB, Azure DocumentDB and other MongoDB-compatible databases, wherever they run. +Version 1.0 of the DocumentDB extension for Visual Studio Code is here. Released alongside [DocumentDB 1.0](https://documentdb.io/blogs/posts/documentdb-1-0/), the free, open-source extension is a **DocumentDB GUI** and MongoDB GUI, right in your editor. It works with DocumentDB, Azure DocumentDB and other MongoDB-compatible databases, wherever they run. The milestone reflects what we built across all the releases on the way to 1.0, over a little more than a year. Version 1.0 focuses on fixes and polish, and celebrates how far that experience has come. Here is the shortest path from reading about DocumentDB 1.0 to working with it: run it locally, bring your own data, and understand what you have. @@ -18,6 +18,8 @@ The quickest way to try DocumentDB 1.0 is **DocumentDB Local**, right from VS Co The extension does the rest: it pulls the official DocumentDB image, creates a persistent volume so your data survives restarts, generates credentials, picks a free port, loads sample data, and saves a ready-to-use connection. No `docker run` command to assemble. From then on, you start, stop or restart the container from the same place, and if Docker isn't ready, the setup tells you exactly what's wrong and how to fix it. +The DocumentDB Local image sends usage telemetry by default. The [privacy statement](https://github.com/documentdb/documentdb/blob/v1.0-0/documentdb-local/PRIVACY.md) explains what is sent and how to turn it off. +

DocumentDB Local setup in VS Code with the Introduction, Configure, Set up and Done steps

## Bring your data with you @@ -52,9 +54,9 @@ Queries don't always come from you anymore. Whether you wrote one yourself or an ## A shared milestone, built in the open -

The road to DocumentDB for VS Code 1.0, from v0.2 in May 2025 to 1.0 in October 2026

+

The road to version 1.0 of the DocumentDB extension for Visual Studio Code, from v0.2 in May 2025 to 1.0 in October 2026

-DocumentDB 1.0 is a milestone for the open-source database. DocumentDB for VS Code 1.0 celebrates the developer experience around it, one that also works with the MongoDB-compatible databases you already run. +DocumentDB 1.0 is a milestone for the open-source database. Version 1.0 of the extension celebrates the developer experience around it, one that also works with the MongoDB-compatible databases you already run. We didn't get here alone. Eleven community developers contributed nearly 30 pull requests along the way, and many more of you shaped the extension with issue reports, accessibility reviews and bug bash findings. Thank you for helping us reach 1.0. @@ -62,8 +64,8 @@ We didn't get here alone. Eleven community developers contributed nearly 30 pull ## Try it -**[Install DocumentDB for VS Code from the Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-documentdb)**, or search for "DocumentDB" in the VS Code Extensions view. +**[Install the DocumentDB extension for Visual Studio Code from the Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-documentdb)**, or search for "DocumentDB" in the VS Code Extensions view. -- [DocumentDB for VS Code 1.0 release notes](https://github.com/microsoft/vscode-documentdb/discussions/1012) (the full tour, with every feature explained) +- [Version 1.0 release notes](https://github.com/microsoft/vscode-documentdb/discussions/1012) (the full tour, with every feature explained) - [Documentation](https://microsoft.github.io/vscode-documentdb/) - [GitHub repository](https://github.com/microsoft/vscode-documentdb) diff --git a/docs/blog-posts/index.md b/docs/blog-posts/index.md index a3fff27bc..cedda4033 100644 --- a/docs/blog-posts/index.md +++ b/docs/blog-posts/index.md @@ -1,5 +1,5 @@ # Blog Posts -Announcements and blog posts about DocumentDB for VS Code. Each post has its own folder, named `YYYY-MM-topic`, containing the post (`index.md`) and its `images/`. +Announcements and blog posts about the DocumentDB extension for Visual Studio Code. Each post has its own folder, named `YYYY-MM-topic`, containing the post (`index.md`) and its `images/`. -- **October 2026:** [DocumentDB for VS Code 1.0: Run It Locally, Bring Your Data](./2026-10-release-1.0/index.md) +- **October 2026:** [DocumentDB extension for Visual Studio Code 1.0: Run It Locally, Bring Your Data](./2026-10-release-1.0/index.md) diff --git a/docs/index.md b/docs/index.md index 16f753da6..da2b198e8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,7 +3,7 @@ title: 'Overview' nav_order: 1 --- -# DocumentDB for VS Code +# DocumentDB extension for Visual Studio Code [Install from Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-documentdb) ยท [Join the Discussion Board](https://github.com/microsoft/vscode-documentdb/discussions) ยท [Report Issues](https://github.com/microsoft/vscode-documentdb/issues) @@ -11,7 +11,7 @@ nav_order: 1 **A powerful, open-source DocumentDB and MongoDB GUI for everyone.** -**DocumentDB for VS Code** helps you browse, manage, and query **DocumentDB** and **MongoDB** databases across any cloud, hybrid, or local environment. +The **DocumentDB extension for Visual Studio Code** helps you browse, manage, and query **DocumentDB** and **MongoDB** databases across any cloud, hybrid, or local environment.

DocumentDB with a Collection View and auto-completion

@@ -27,7 +27,7 @@ Connect to any MongoDB or DocumentDB instance: cloud, hybrid cloud, on-premises, ### Developer-Centric Experience -DocumentDB for VS Code focuses on providing developer productivity features with minimal setup. +The extension focuses on providing developer productivity features with minimal setup. - **Query Your Data, Your Way**: Three integrated query surfaces: the visual **Collection View** with context-aware autocompletion, the file-based **Query Playground** for JavaScript scripts, and the built-in **Interactive Shell** for ad-hoc exploration. All three share schema awareness and are linked with navigation actions. - **Multiple Data Views**: Inspect collections using **Table**, **Tree**, or **JSON** layouts, with built-in pagination. @@ -42,7 +42,7 @@ Your feedback, contributions, and ideas shape the future of the extension. ## User Manual -The User Manual provides guidance on using DocumentDB for VS Code. It contains detailed documentation for specific features and concepts. These documents provide additional context and examples for features you encounter while using the extension: +The User Manual provides guidance on using the extension. It contains detailed documentation for specific features and concepts. These documents provide additional context and examples for features you encounter while using the extension: ### Connecting to Databases @@ -82,9 +82,9 @@ The User Manual provides guidance on using DocumentDB for VS Code. It contains d ## Release Notes -Explore the history of updates and improvements to the DocumentDB for VS Code extension. Each release brings new features, enhancements, and fixes to improve your experience. +Explore the history of updates and improvements to the extension. Each release brings new features, enhancements, and fixes to improve your experience. -- [1.0](./release-notes/1.0) +- [1.0](./release-notes/1.0), [1.0.1](./release-notes/1.0#patch-release-v101) - [0.11](./release-notes/0.11), [0.11.1](./release-notes/0.11#patch-release-v0111), [0.11.2](./release-notes/0.11#patch-release-v0112) - [0.10](./release-notes/0.10), [0.10.1](./release-notes/0.10#patch-release-v0101), [0.10.2](./release-notes/0.10#patch-release-v0102) - [0.9](./release-notes/0.9), [0.9.1](./release-notes/0.9#patch-release-v091), [0.9.2](./release-notes/0.9#patch-release-v092) diff --git a/docs/release-notes.md b/docs/release-notes.md index b59935622..2d23739c0 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -8,4 +8,4 @@ permalink: /release-notes/ # Release Notes -What changed in each release of DocumentDB for VS Code. +What changed in each release of the DocumentDB extension for Visual Studio Code. diff --git a/docs/release-notes/1.0.md b/docs/release-notes/1.0.md index eac000430..8dfa542fb 100644 --- a/docs/release-notes/1.0.md +++ b/docs/release-notes/1.0.md @@ -4,27 +4,27 @@ parent: 'Release Notes' nav_order: 1000 --- -# DocumentDB for VS Code Extension v1.0 +# DocumentDB extension for Visual Studio Code v1.0 -

DocumentDB for VS Code 1.0: connect, explore, query, optimize and move your MongoDB-compatible data without leaving your editor

+

DocumentDB extension for Visual Studio Code 1.0: connect, explore, query, optimize and move your MongoDB-compatible data without leaving your editor

-We are proud to announce **DocumentDB for VS Code Extension v1.0**. +We are proud to announce **version 1.0 of the DocumentDB extension for Visual Studio Code**. -**New here?** DocumentDB for VS Code is a free, open-source **MongoDB GUI** and **DocumentDB GUI**, built right into Visual Studio Code. It works with [DocumentDB](https://documentdb.io/), the open-source document database built on PostgreSQL, with Azure DocumentDB, and with other MongoDB-compatible databases, wherever they run: on your laptop, in Kubernetes, on Azure, or in MongoDB Atlas. You can connect, browse and edit documents, write and run queries, find out why a query is slow, and move data between environments, without switching tools. +**New here?** The DocumentDB extension is a free, open-source **MongoDB GUI** and **DocumentDB GUI**, built right into Visual Studio Code. It works with [DocumentDB](https://documentdb.io/), the open-source document database built on PostgreSQL, with Azure DocumentDB, and with other MongoDB-compatible databases, wherever they run: on your laptop, in Kubernetes, on Azure, or in MongoDB Atlas. You can connect, browse and edit documents, write and run queries, find out why a query is slow, and move data between environments, without switching tools. We are celebrating this milestone alongside [DocumentDB 1.0](https://documentdb.io/), the open-source document database. For the extension, 1.0 recognizes the work that brought these everyday workflows together. This release focuses on fixes and polish; the capabilities below were built across all the releases on the way to 1.0. -If you have been with us along the way, thank you. If you are joining now, here is what you can do with DocumentDB for VS Code today. +If you have been with us along the way, thank you. If you are joining now, here is what you can do with the extension today. -

Install DocumentDB for VS Code from the Visual Studio Marketplace
Free and open source. Everything is bundled, so there is nothing else to install.

+

Install DocumentDB extension in VS Code from the Visual Studio Marketplace
Free and open source. Everything is bundled, so there is nothing else to install.

> ๐Ÿš€ **Trying DocumentDB 1.0?** Start with [DocumentDB Local](#no-database-yet-start-documentdb-local) to run it on your machine in a few clicks, then [bring your own data with copy and paste](#copy-and-paste-collections). -## A Tour of DocumentDB for VS Code +## A Tour of the DocumentDB Extension Working with data usually follows the same arc. It starts with a **connection**: a local database on your laptop, a cluster in Kubernetes, or a service on Azure or MongoDB Atlas. Then you **explore**: you get a feel for what a cluster holds and what the documents look like. And then the **heavier work** begins: writing and refining queries, finding out why one is slow, and moving data to where it's needed. -DocumentDB for VS Code covers that whole arc. We'll start where you meet your data most directly, the query, whether you write it yourself or an AI agent writes it for you, and then show everything around it. +The extension covers that whole arc. We'll start where you meet your data most directly, the query, whether you write it yourself or an AI agent writes it for you, and then show everything around it. ### One Query, Many Ways to Work With It @@ -93,7 +93,7 @@ Querying is the heart of the extension, but it is not the whole story. Here is e ### โญ Connect: Start Where Your Data Already Lives -Before you can work with data, you need a connection. DocumentDB for VS Code gives you several ways to get one, and keeps your connections in the **Connections** view, organized in folders you create (for example "Production" and "Development"). +Before you can work with data, you need a connection. The extension gives you several ways to get one, and keeps your connections in the **Connections** view, organized in folders you create (for example "Production" and "Development"). #### No database yet? Start DocumentDB Local @@ -119,7 +119,7 @@ From then on, start, stop, restart or delete the container from the Connections #### Using MongoDB Atlas? Browse and connect to your Atlas clusters in VS Code -If your data lives in **MongoDB Atlas**, DocumentDB for VS Code works as a free, open-source MongoDB GUI for your Atlas clusters, right inside your editor. **MongoDB Atlas discovery** brings your Atlas organizations, projects and clusters into the **Service Discovery** view, so you can find a cluster and connect to it without hunting for its endpoint in the Atlas console. +If your data lives in **MongoDB Atlas**, the DocumentDB extension works as a free, open-source MongoDB GUI for your Atlas clusters, right inside your editor. **MongoDB Atlas discovery** brings your Atlas organizations, projects and clusters into the **Service Discovery** view, so you can find a cluster and connect to it without hunting for its endpoint in the Atlas console. To start, expand **MongoDB Atlas** in the **Service Discovery** view and select **Sign in to view MongoDB Atlas clusters** (or choose **New Connection** > **Service Discovery** > **MongoDB Atlas**). A short guided setup asks how the extension should sign in to Atlas: @@ -143,9 +143,9 @@ Once connected, an Atlas cluster works like any other connection: browse it in t #### Working in Azure every day? Use the Azure Resources view -If you already manage your cloud resources with the [Azure Resources](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups) extension, you don't need a separate place to find your databases. DocumentDB for VS Code plugs directly into the **Azure** view: your Azure DocumentDB clusters and Azure Cosmos DB for MongoDB (RU) accounts appear in the same resource tree as your App Services, Functions and storage accounts, grouped the way you are used to (by subscription, resource group or resource type). +If you already manage your cloud resources with the [Azure Resources](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups) extension, you don't need a separate place to find your databases. The DocumentDB extension plugs directly into the **Azure** view: your Azure DocumentDB clusters and Azure Cosmos DB for MongoDB (RU) accounts appear in the same resource tree as your App Services, Functions and storage accounts, grouped the way you are used to (by subscription, resource group or resource type). -Expand an Azure DocumentDB cluster there and it opens into its databases and collections, with the full DocumentDB for VS Code experience one click away: open the Collection View, start a Query Playground or open the Interactive Shell. There is no extra connection to create and no connection string to copy. If Azure is the center of your work, this is likely the most natural way in. If you also work with databases outside Azure, the **Service Discovery** and **Connections** views bring everything together in one place. +Expand an Azure DocumentDB cluster there and it opens into its databases and collections, with the full DocumentDB extension experience one click away: open the Collection View, start a Query Playground or open the Interactive Shell. There is no extra connection to create and no connection string to copy. If Azure is the center of your work, this is likely the most natural way in. If you also work with databases outside Azure, the **Service Discovery** and **Connections** views bring everything together in one place. #### Or paste a connection string @@ -221,7 +221,7 @@ Import documents from JSON files into a collection, or export documents to JSON. ## The Road to 1.0 -

The road to DocumentDB for VS Code 1.0: an illustrated S-shaped road from v0.2 in May 2025, through releases for Entra ID sign-in, Query Insights with AI, copy and paste, the Shell and Playground, Kubernetes discovery, DocumentDB Local and the Cluster Dashboard, to the 1.0 summit in October 2026

+

The road to version 1.0 of the DocumentDB extension for Visual Studio Code: an illustrated S-shaped road from v0.2 in May 2025, through releases for Entra ID sign-in, Query Insights with AI, copy and paste, the Shell and Playground, Kubernetes discovery, DocumentDB Local and the Cluster Dashboard, to the 1.0 summit in October 2026

We started with the visual way. The first release, a little over a year ago, let you browse documents in Table, Tree and JSON views. For more complex tasks we then added the Interactive Shell and the Query Playground, with autocompletion everywhere. And we topped it off with helpers that make the work easier: Query Insights, index management and the Cluster Dashboard. Along the way, the extension also learned to find your databases on Azure, in Kubernetes and in MongoDB Atlas, and to start one for you with DocumentDB Local. @@ -234,7 +234,7 @@ Each release has its own notes in the [release notes index](../index.md#release- Version 1.0 itself ships two changes. The [changelog](#changelog) has the details. - **Tell us how we're doing**: a short, optional feedback invitation can appear in the Secondary Sidebar after you have used the extension on a few different days, while you work in Collection View or the Cluster Dashboard. Automatic invitations respect VS Code's `telemetry.feedback.enabled` setting, and you can postpone them or turn them off for good. Open the same feedback view yourself from Collection View, the Cluster Dashboard, the setup wizards, Help and Feedback, or **DocumentDB: Give Feedback** in the Command Palette. ([#992](https://github.com/microsoft/vscode-documentdb/pull/992), [#1016](https://github.com/microsoft/vscode-documentdb/pull/1016)) -- **Lighter panels and a modernized build**: each panel now loads only the code it needs, and the extension is built and tested with a modern toolchain and checked as a packaged extension before every release. Setup wizard headers also have more room for actions while their content keeps its familiar width. DocumentDB for VS Code now requires VS Code 1.109.0 or later. ([#880](https://github.com/microsoft/vscode-documentdb/pull/880), [#1016](https://github.com/microsoft/vscode-documentdb/pull/1016)) +- **Lighter panels and a modernized build**: each panel now loads only the code it needs, and the extension is built and tested with a modern toolchain and checked as a packaged extension before every release. Setup wizard headers also have more room for actions while their content keeps its familiar width. The extension now requires VS Code 1.109.0 or later. ([#880](https://github.com/microsoft/vscode-documentdb/pull/880), [#1016](https://github.com/microsoft/vscode-documentdb/pull/1016)) ## Thank You @@ -244,9 +244,9 @@ Keep it coming: tell us what you'd like next on [GitHub](https://github.com/micr ## Make Your Next Query in VS Code -Install or update DocumentDB for VS Code, connect to a database or set up DocumentDB Local, and open a collection. Start visually, try the Shell, or create a Playground. The best place to start is the question you want to answer. +Install or update the DocumentDB extension, connect to a database or set up DocumentDB Local, and open a collection. Start visually, try the Shell, or create a Playground. The best place to start is the question you want to answer. -

Install DocumentDB for VS Code from the Visual Studio Marketplace

+

Install DocumentDB extension in VS Code from the Visual Studio Marketplace

[Read the documentation](https://microsoft.github.io/vscode-documentdb/) ยท [DocumentDB](https://documentdb.io/) ยท [GitHub repository](https://github.com/microsoft/vscode-documentdb) @@ -254,3 +254,26 @@ Install or update DocumentDB for VS Code, connect to a database or set up Docume See the full changelog entry for this release: โžก๏ธ [CHANGELOG.md#100](https://github.com/microsoft/vscode-documentdb/blob/main/CHANGELOG.md#100) + +--- + +## Patch Release v1.0.1 + +This patch release brings the extension's new name, **DocumentDB extension for Visual Studio Code**, to the product, the documentation and the docs site. + +### What's Changed in v1.0.1 + +#### ๐Ÿ’  **A New Name: DocumentDB** ([#1024](https://github.com/microsoft/vscode-documentdb/issues/1024), [#1027](https://github.com/microsoft/vscode-documentdb/issues/1027), [#1035](https://github.com/microsoft/vscode-documentdb/pull/1035)) + +The extension is now the **DocumentDB extension for Visual Studio Code**, matching how it is presented alongside DocumentDB 1.0 on [documentdb.io](https://documentdb.io/). Inside VS Code it goes by its short name, **DocumentDB**: in the Extensions view, the walkthrough, the settings group under **Extensions**, and the output channel, which is now called **DocumentDB**. + +Nothing changes in how you work. The extension ID `ms-azuretools.vscode-documentdb`, your settings, saved connections and commands stay the same. When you look for logs, open the **DocumentDB** output channel. + +#### ๐Ÿ’  **Updated Documentation** ([#1025](https://github.com/microsoft/vscode-documentdb/issues/1025), [#1029](https://github.com/microsoft/vscode-documentdb/issues/1029), [#1030](https://github.com/microsoft/vscode-documentdb/issues/1030)) + +The README, the user manual and the [documentation site](https://microsoft.github.io/vscode-documentdb/) now use the new name, and the contributor guidance explains when to use the full name and when "DocumentDB" is enough. + +### Changelog + +See the full changelog entry for this release: +โžก๏ธ [CHANGELOG.md#101](https://github.com/microsoft/vscode-documentdb/blob/main/CHANGELOG.md#101) diff --git a/docs/release-notes/images/1.0.0_hero.png b/docs/release-notes/images/1.0.0_hero.png index 82acd0c17..6cb665263 100644 Binary files a/docs/release-notes/images/1.0.0_hero.png and b/docs/release-notes/images/1.0.0_hero.png differ diff --git a/docs/release-notes/images/1.0.0_hero_dark.png b/docs/release-notes/images/1.0.0_hero_dark.png index 35db1bca4..424661a87 100644 Binary files a/docs/release-notes/images/1.0.0_hero_dark.png and b/docs/release-notes/images/1.0.0_hero_dark.png differ diff --git a/docs/release-notes/images/1.0.0_install_button.png b/docs/release-notes/images/1.0.0_install_button.png index 6973bf801..55bb3d240 100644 Binary files a/docs/release-notes/images/1.0.0_install_button.png and b/docs/release-notes/images/1.0.0_install_button.png differ diff --git a/docs/user-manual.md b/docs/user-manual.md index a1068e262..cf6368fb0 100644 --- a/docs/user-manual.md +++ b/docs/user-manual.md @@ -7,4 +7,4 @@ permalink: /user-manual/ # User Manual -Guides for connecting to databases, managing data and querying with DocumentDB for VS Code. +Guides for connecting to databases, managing data and querying with the DocumentDB extension for Visual Studio Code. diff --git a/docs/user-manual/copy-and-paste.md b/docs/user-manual/copy-and-paste.md index 0257f1ca4..218b58485 100644 --- a/docs/user-manual/copy-and-paste.md +++ b/docs/user-manual/copy-and-paste.md @@ -6,7 +6,7 @@ nav_order: 3 # Copy and Paste Collections -The **Copy and Paste** feature in DocumentDB for VS Code provides a convenient way to move smaller datasets between collections, whether they are on the same server or across different connections. It is designed for quick, ad-hoc data transfers directly within the VS Code environment. +The **Copy and Paste** feature in the DocumentDB extension for Visual Studio Code provides a convenient way to move smaller datasets between collections, whether they are on the same server or across different connections. It is designed for quick, ad-hoc data transfers directly within the VS Code environment. **Table of Contents** @@ -95,7 +95,7 @@ The copy-and-paste operation is **not an atomic snapshot**. It is a live data tr Because this feature streams data through your local machine, it can be slow and resource-intensive for very large collections. To prevent accidental performance issues, the extension will show a warning for collections that exceed a certain size. -Open VS Code Settings and expand **Extensions** > **DocumentDB for VS Code** > **Copy & Paste** to +Open VS Code Settings and expand **Extensions** > **DocumentDB** > **Copy & Paste** to customize this behavior. You can also search for either setting ID: - **`documentDB.copyPaste.showLargeCollectionWarning`**: (Default: `true`) Set to `false` to disable the warning entirely. @@ -266,7 +266,7 @@ The best tool often depends on your data source, target, and migration requireme For example, Microsoft provides guidance on migrating between different versions of its own services, such as from Azure Cosmos DB for MongoDB (RU) to the vCore-based service: [Migrate from Azure Cosmos DB for MongoDB (RU) to Azure Cosmos DB for MongoDB (vCore)](https://learn.microsoft.com/en-us/azure/cosmos-db/mongodb/how-to-migrate-vcore) -The linked documentation covers the broader migration options, but DocumentDB for VS Code can help you get started too: +The linked documentation covers the broader migration options, but the extension can help you get started too: 1. Locate the **source cluster** you want to migrate **from** in the Connections, Discovery, or Azure view. 2. Right-click the cluster and select **Data Migrationโ€ฆ**. diff --git a/docs/user-manual/data-migrations.md b/docs/user-manual/data-migrations.md index 8cdd9e4b2..af9e9a3e1 100644 --- a/docs/user-manual/data-migrations.md +++ b/docs/user-manual/data-migrations.md @@ -4,13 +4,13 @@ parent: 'Data Management' nav_order: 2 --- -# Data Migrations in DocumentDB for VS Code +# Data Migrations in the DocumentDB extension for Visual Studio Code -**DocumentDB for VS Code** provides a powerful and extensible data migration framework that enables seamless data movement between different database systems, cloud platforms, and local environments. This feature is designed to simplify complex migration scenarios while maintaining full control over the migration process. +The **DocumentDB extension for Visual Studio Code** provides a powerful and extensible data migration framework that enables seamless data movement between different database systems, cloud platforms, and local environments. This feature is designed to simplify complex migration scenarios while maintaining full control over the migration process. ## How Data Migrations Work -The migration system in DocumentDB for VS Code is built on a **provider-based architecture**. Each migration provider is a specialized extension that understands how to handle migrations for specific platforms, tools, or migration scenarios. +The migration system in the extension is built on a **provider-based architecture**. Each migration provider is a specialized extension that understands how to handle migrations for specific platforms, tools, or migration scenarios. ## How to Use Data Migrations diff --git a/docs/user-manual/how-to-construct-url.md b/docs/user-manual/how-to-construct-url.md index 195705db1..69efd429a 100644 --- a/docs/user-manual/how-to-construct-url.md +++ b/docs/user-manual/how-to-construct-url.md @@ -6,14 +6,14 @@ nav_order: 1 # How to Construct a URL That Opens the Extension -**DocumentDB for VS Code** supports activation through custom URLs, enabling you to integrate the extension seamlessly with your development environment and build deep links directly to your DocumentDB and MongoDB clusters. This powerful feature allows you to create shortcuts that can open specific connections, navigate to particular databases, or even jump directly to a collection view within the extension. +The **DocumentDB extension for Visual Studio Code** supports activation through custom URLs, enabling you to integrate the extension seamlessly with your development environment and build deep links directly to your DocumentDB and MongoDB clusters. This powerful feature allows you to create shortcuts that can open specific connections, navigate to particular databases, or even jump directly to a collection view within the extension. This URL-based activation is particularly useful for: - **Development Workflow Integration:** Create bookmarks or shortcuts that instantly connect to your frequently used databases - **Team Collaboration:** Share direct links to specific database resources with your team members - **Documentation and Tutorials:** Embed clickable links in documentation that open specific database connections -- **External Tool Integration:** Allow other applications to launch DocumentDB for VS Code with pre-configured connections +- **External Tool Integration:** Allow other applications to launch the extension with pre-configured connections ## URL Syntax @@ -158,9 +158,9 @@ confirmation before opening the setup wizard. ## How It Works -When you click a DocumentDB for VS Code URL, the following process occurs: +When you click a URL for the extension, the following process occurs: -1. **Activation**: The `vscode://` prefix tells the operating system to activate VS Code. The `ms-azuretools.vscode-documentdb` segment activates the **DocumentDB for VS Code** extension. +1. **Activation**: The `vscode://` prefix tells the operating system to activate VS Code. The `ms-azuretools.vscode-documentdb` segment activates the **DocumentDB** extension. 2. **Action routing**: The extension reads the action from the path. An unrecognized action is refused rather than guessed at, so a mistyped link never acts on parameters you did not intend for it. diff --git a/docs/user-manual/interactive-shell.md b/docs/user-manual/interactive-shell.md index 3f9baf132..09ca684ab 100644 --- a/docs/user-manual/interactive-shell.md +++ b/docs/user-manual/interactive-shell.md @@ -219,7 +219,7 @@ For more details on the Query Playground, see the [Query Playground](./query-pla ## Settings -Open VS Code Settings and expand **Extensions** > **DocumentDB for VS Code**. The display and paste +Open VS Code Settings and expand **Extensions** > **DocumentDB**. The display and paste options are under **Interactive Shell**. The shared connection timeout is under **Connections & Discovery**, and the shared batch size is under **Queries & Results**. You can also search for a setting ID from the table. diff --git a/docs/user-manual/local-connection-documentdb-local.md b/docs/user-manual/local-connection-documentdb-local.md index 8764f7b08..ef04112af 100644 --- a/docs/user-manual/local-connection-documentdb-local.md +++ b/docs/user-manual/local-connection-documentdb-local.md @@ -15,5 +15,5 @@ Use the manual connection flow when DocumentDB Local is already running and you ## How to Use - Ensure you have a DocumentDB instance reachable from the VS Code extension host. -- In DocumentDB for VS Code, select the **DocumentDB Local** option from the local connection area. +- In the DocumentDB extension for Visual Studio Code, select the **DocumentDB Local** option from the local connection area. - The extension will guide you through the connection process, allowing you to specify connection details and adjust security settings as needed. diff --git a/docs/user-manual/local-connection-mongodb-ru.md b/docs/user-manual/local-connection-mongodb-ru.md index d9c8fe08c..ad5890c83 100644 --- a/docs/user-manual/local-connection-mongodb-ru.md +++ b/docs/user-manual/local-connection-mongodb-ru.md @@ -13,7 +13,7 @@ The **Azure CosmosDB for MongoDB (RU) Emulator** allows you to develop and test - Install the Azure CosmosDB Emulator on your local machine. [Official documentation and download](https://learn.microsoft.com/azure/cosmos-db/local-emulator) - Start the emulator. It will expose a local endpoint for MongoDB connections. -- In DocumentDB for VS Code, choose the **Azure CosmosDB for MongoDB (RU) Emulator** option from the local connection area. +- In the DocumentDB extension for Visual Studio Code, choose the **Azure CosmosDB for MongoDB (RU) Emulator** option from the local connection area. - The extension will pre-fill the connection string and handle any required configuration. ## Features diff --git a/docs/user-manual/local-connection.md b/docs/user-manual/local-connection.md index 57b094271..22da211df 100644 --- a/docs/user-manual/local-connection.md +++ b/docs/user-manual/local-connection.md @@ -7,7 +7,7 @@ has_toc: false # Local Connection -**DocumentDB for VS Code** allows you to connect to local DocumentDB and MongoDB instances. This can be useful for development, testing, or working with emulators on your own machine. +The **DocumentDB extension for Visual Studio Code** allows you to connect to local DocumentDB and MongoDB instances. This can be useful for development, testing, or working with emulators on your own machine.

Local connection UI screenshot

@@ -42,7 +42,7 @@ TLS/SSL provides encryption for data in transit, protecting your information fro ### Local Development Considerations -We understand that setting up TLS/SSL for local deployments can sometimes be inconvenient or unnecessary, especially when you're just experimenting or developing on your own machine. For this reason, the extension allows you to disable the security requirement for local connections. When this option is selected, DocumentDB for VS Code will not verify SSL/TLS certificates. +We understand that setting up TLS/SSL for local deployments can sometimes be inconvenient or unnecessary, especially when you're just experimenting or developing on your own machine. For this reason, the extension allows you to disable the security requirement for local connections. When this option is selected, the extension will not verify SSL/TLS certificates. ### A Note on Security Best Practices diff --git a/docs/user-manual/managing-azure-discovery.md b/docs/user-manual/managing-azure-discovery.md index 94d75faa8..d5c574d46 100644 --- a/docs/user-manual/managing-azure-discovery.md +++ b/docs/user-manual/managing-azure-discovery.md @@ -6,7 +6,7 @@ nav_order: 6 # Managing Azure Discovery (Accounts, Tenants, and Subscriptions) -When using Azure-based service discovery providers in DocumentDB for VS Code, you have access to shared features for managing your Azure credentials and filtering which resources are displayed. These features are consistent across all Azure service discovery providers: +When using Azure-based service discovery providers in the DocumentDB extension for Visual Studio Code, you have access to shared features for managing your Azure credentials and filtering which resources are displayed. These features are consistent across all Azure service discovery providers: - [Azure Cosmos DB for MongoDB (RU)](./service-discovery-azure-cosmosdb-for-mongodb-ru) - [Azure DocumentDB](./service-discovery-azure-cosmosdb-for-mongodb-vcore) @@ -83,7 +83,7 @@ The credential management wizard does **not** provide a sign-out option. If you 2. Select the account you want to sign out from 3. Choose **"Sign Out"** -> **โš ๏ธ Important**: Signing out from an Azure account in VS Code will sign you out globally across VS Code, not just from the DocumentDB for VS Code extension. This may affect other extensions that use the same Azure account. +> **โš ๏ธ Important**: Signing out from an Azure account in VS Code will sign you out globally across VS Code, not just from the DocumentDB extension. This may affect other extensions that use the same Azure account. --- diff --git a/docs/user-manual/query-playground.md b/docs/user-manual/query-playground.md index 53187d3c2..a5bd3c7d4 100644 --- a/docs/user-manual/query-playground.md +++ b/docs/user-manual/query-playground.md @@ -183,7 +183,7 @@ For more details on the Interactive Shell, see the [Interactive Shell](./interac ## Settings -Open VS Code Settings and expand **Extensions** > **DocumentDB for VS Code**. The Run All confirmation +Open VS Code Settings and expand **Extensions** > **DocumentDB**. The Run All confirmation is under **Query Playground**. The shared batch size is under **Queries & Results**, and the shared connection timeout is under **Connections & Discovery**. You can also search for a setting ID from the table. diff --git a/docs/user-manual/service-discovery-azure-cosmosdb-for-mongodb-ru.md b/docs/user-manual/service-discovery-azure-cosmosdb-for-mongodb-ru.md index 974162267..8ef36b922 100644 --- a/docs/user-manual/service-discovery-azure-cosmosdb-for-mongodb-ru.md +++ b/docs/user-manual/service-discovery-azure-cosmosdb-for-mongodb-ru.md @@ -6,7 +6,7 @@ nav_order: 2 # Azure CosmosDB for MongoDB (RU) Service Discovery Plugin -The **Azure CosmosDB for MongoDB (RU)** plugin is available as part of the [Service Discovery](./service-discovery) feature in DocumentDB for VS Code. This plugin helps you find and connect to Azure Cosmos DB accounts provisioned with Request Units (RU) for the MongoDB API by handling authentication, resource discovery, and connection creation from inside the extension. +The **Azure CosmosDB for MongoDB (RU)** plugin is available as part of the [Service Discovery](./service-discovery) feature in the DocumentDB extension for Visual Studio Code. This plugin helps you find and connect to Azure Cosmos DB accounts provisioned with Request Units (RU) for the MongoDB API by handling authentication, resource discovery, and connection creation from inside the extension. > **๐Ÿ“˜ Managing Azure Resources**: This provider shares common Azure management features with other Azure-based providers. See [Managing Azure Discovery (Accounts, Tenants, and Subscriptions)](./managing-azure-discovery) for detailed information about: > diff --git a/docs/user-manual/service-discovery-azure-cosmosdb-for-mongodb-vcore.md b/docs/user-manual/service-discovery-azure-cosmosdb-for-mongodb-vcore.md index 16e6247e3..5973deff1 100644 --- a/docs/user-manual/service-discovery-azure-cosmosdb-for-mongodb-vcore.md +++ b/docs/user-manual/service-discovery-azure-cosmosdb-for-mongodb-vcore.md @@ -6,7 +6,7 @@ nav_order: 1 # Azure DocumentDB Service Discovery Plugin -The **Azure DocumentDB** plugin is available as part of the [Service Discovery](./service-discovery) feature in DocumentDB for VS Code. This plugin helps you connect to your Azure DocumentDB clusters by handling authentication, resource discovery, and connection management within the extension. +The **Azure DocumentDB** plugin is available as part of the [Service Discovery](./service-discovery) feature in the DocumentDB extension for Visual Studio Code. This plugin helps you connect to your Azure DocumentDB clusters by handling authentication, resource discovery, and connection management within the extension. > **๐Ÿ“˜ Managing Azure Resources**: This provider shares common Azure management features with other Azure-based providers. See [Managing Azure Discovery (Accounts, Tenants, and Subscriptions)](./managing-azure-discovery) for detailed information about: > diff --git a/docs/user-manual/service-discovery-azure-vms.md b/docs/user-manual/service-discovery-azure-vms.md index e2c1cc42d..8a9a78a46 100644 --- a/docs/user-manual/service-discovery-azure-vms.md +++ b/docs/user-manual/service-discovery-azure-vms.md @@ -6,7 +6,7 @@ nav_order: 3 # Azure VMs (DocumentDB) Service Discovery Plugin -The **Azure VMs (DocumentDB)** plugin is available as part of the [Service Discovery](./service-discovery) feature in DocumentDB for VS Code. This plugin helps you locate and connect to your virtual machines hosted in Azure that are running self-hosted DocumentDB or MongoDB instances. +The **Azure VMs (DocumentDB)** plugin is available as part of the [Service Discovery](./service-discovery) feature in the DocumentDB extension for Visual Studio Code. This plugin helps you locate and connect to your virtual machines hosted in Azure that are running self-hosted DocumentDB or MongoDB instances. > **๐Ÿ“˜ Managing Azure Resources**: This provider shares common Azure management features with other Azure-based providers. See [Managing Azure Discovery (Accounts, Tenants, and Subscriptions)](./managing-azure-discovery) for detailed information about: > diff --git a/docs/user-manual/service-discovery-kubernetes.md b/docs/user-manual/service-discovery-kubernetes.md index 4e99d8490..64d423bea 100644 --- a/docs/user-manual/service-discovery-kubernetes.md +++ b/docs/user-manual/service-discovery-kubernetes.md @@ -238,7 +238,7 @@ When you **save** a discovered target to the Connections view, the `tlsAllowInva | **ClusterIP** | Starts a local port-forward tunnel to a ready backing pod and connects through `127.0.0.1:`. | | **ExternalName** | Not resolved automatically. Use the external DNS name to connect manually. | -For ClusterIP targets the extension prompts for a local port when needed. By default, the suggested local port matches the remote service port. Open VS Code Settings and expand **Extensions** > **DocumentDB for VS Code** > **Connections & Discovery** to change this behavior. You can also search for either setting ID: +For ClusterIP targets the extension prompts for a local port when needed. By default, the suggested local port matches the remote service port. Open VS Code Settings and expand **Extensions** > **DocumentDB** > **Connections & Discovery** to change this behavior. You can also search for either setting ID: - **Local Port Strategy** (`documentDB.serviceDiscovery.kubernetes.portForward.localPortStrategy`): - **matchRemote**: use the same port number as the remote Kubernetes service port. diff --git a/docs/user-manual/service-discovery-mongodb-atlas.md b/docs/user-manual/service-discovery-mongodb-atlas.md index 55f7e49b2..4109aead4 100644 --- a/docs/user-manual/service-discovery-mongodb-atlas.md +++ b/docs/user-manual/service-discovery-mongodb-atlas.md @@ -7,7 +7,7 @@ has_toc: false # MongoDB Atlas Service Discovery -MongoDB Atlas Service Discovery lets you browse Atlas organizations, projects, and clusters from DocumentDB for VS Code. You can then create a connection from a discovered cluster without manually copying its endpoint. +MongoDB Atlas Service Discovery lets you browse Atlas organizations, projects, and clusters from the DocumentDB extension for Visual Studio Code. You can then create a connection from a discovered cluster without manually copying its endpoint. Use MongoDB Atlas Service Discovery from either location: @@ -37,7 +37,7 @@ The Atlas API Key or Service Account is used only to discover resources. It is n 6. Enter the Atlas database username and password when prompted. 7. Save the connection or open the cluster to work with its databases and collections. -The extension prefers the Atlas SRV connection string when Atlas provides one. The saved result is a regular DocumentDB for VS Code connection. +The extension prefers the Atlas SRV connection string when Atlas provides one. The saved result is a regular connection in the extension. ## What to do next diff --git a/docs/user-manual/service-discovery.md b/docs/user-manual/service-discovery.md index 0aad92916..9c1eb7fa4 100644 --- a/docs/user-manual/service-discovery.md +++ b/docs/user-manual/service-discovery.md @@ -5,9 +5,9 @@ nav_order: 4 has_toc: false --- -# Service Discovery in DocumentDB for VS Code +# Service Discovery in the DocumentDB extension for Visual Studio Code -**DocumentDB for VS Code** is built with an open architecture. While the extension focuses on developer productivity (data exploration, running queries, and importing/exporting data), the core connectivity is centered around connection strings. +The **DocumentDB extension for Visual Studio Code** is built with an open architecture. While the extension focuses on developer productivity (data exploration, running queries, and importing/exporting data), the core connectivity is centered around connection strings. ## How Service Discovery Works @@ -16,7 +16,7 @@ A **Service Discovery plugin** is designed to understand a specific vendor envir - **Authentication:** Handling the process of logging in or obtaining credentials for the target platform. - **Navigation:** Guiding the user through the internal platform, systems, or APIs to locate relevant resources. - **Discovery:** Identifying available database services or endpoints. -- **Connection Sharing:** Once discovery is complete, the plugin provides a connection string to DocumentDB for VS Code. From there, the extension manages the connection and enables you to work with your data. +- **Connection Sharing:** Once discovery is complete, the plugin provides a connection string to the extension. From there, the extension manages the connection and enables you to work with your data. This approach allows you to connect to a variety of platforms without needing to manually gather connection details. The plugin handles the complexity of each environment, so you can focus on your development tasks. @@ -45,4 +45,4 @@ If you are interested in contributing, now is a great time to get involved and h Would you like to add your own service discovery provider? Would you like to suggest a provider to be added? Do you have feedback or suggestions about the existing plugins? -We encourage you to [join the discussion board](https://github.com/microsoft/vscode-documentdb/discussions) and share your ideas or questions. Collaboration and feedback from developers like you are essential to making DocumentDB for VS Code more useful and adaptable to a wide range of environments. +We encourage you to [join the discussion board](https://github.com/microsoft/vscode-documentdb/discussions) and share your ideas or questions. Collaboration and feedback from developers like you are essential to making the extension more useful and adaptable to a wide range of environments. diff --git a/docs/user-manual/troubleshooting-srv-dns.md b/docs/user-manual/troubleshooting-srv-dns.md index 95d483556..28cbe9332 100644 --- a/docs/user-manual/troubleshooting-srv-dns.md +++ b/docs/user-manual/troubleshooting-srv-dns.md @@ -85,7 +85,7 @@ The `documentDB.connectionTimeout` setting starts counting **after** the DNS loo ## Collect a trace for support -1. Open the **Output** panel and select **DocumentDB for VS Code**. +1. Open the **Output** panel and select **DocumentDB**. 2. Set the log level to **Trace** (the gear icon in the Output panel, or **Developer: Set Log Levelโ€ฆ**). 3. Connect again. 4. Copy the lines that start with `[SrvResolution]`. diff --git a/l10n/bundle.l10n.json b/l10n/bundle.l10n.json index 226ebdc2a..fd4d37de0 100644 --- a/l10n/bundle.l10n.json +++ b/l10n/bundle.l10n.json @@ -614,7 +614,7 @@ "Connection timed out": "Connection timed out", "Connection to \"{cluster}\" was cancelled.": "Connection to \"{cluster}\" was cancelled.", "Connection updated successfully.": "Connection updated successfully.", - "Connection: \"{selectedConnectionName}\"\n\nThe connection will be added to the \"Connections View\" in the \"DocumentDB for VS Code\" extension. The \"Connections View\" will be opened once this process completes.\n\nDo you want to continue?": "Connection: \"{selectedConnectionName}\"\n\nThe connection will be added to the \"Connections View\" in the \"DocumentDB for VS Code\" extension. The \"Connections View\" will be opened once this process completes.\n\nDo you want to continue?", + "Connection: \"{selectedConnectionName}\"\n\nThe connection will be added to the \"Connections View\" in the DocumentDB extension. The \"Connections View\" will be opened once this process completes.\n\nDo you want to continue?": "Connection: \"{selectedConnectionName}\"\n\nThe connection will be added to the \"Connections View\" in the DocumentDB extension. The \"Connections View\" will be opened once this process completes.\n\nDo you want to continue?", "Connection: {0}": "Connection: {0}", "Connection: {connectionName}": "Connection: {connectionName}", "Connections (m)": "Connections (m)", @@ -853,9 +853,6 @@ "DocumentDB did not accept connections in time. Docker may be running on the dev container host, so the published localhost port might not be reachable from inside the dev container.": "DocumentDB did not accept connections in time. Docker may be running on the dev container host, so the published localhost port might not be reachable from inside the dev container.", "DocumentDB did not accept connections in time. It may still be initializing.": "DocumentDB did not accept connections in time. It may still be initializing.", "DocumentDB Documentation": "DocumentDB Documentation", - "DocumentDB for VS Code": "DocumentDB for VS Code", - "DocumentDB for VS Code has been updated. View the release notes?": "DocumentDB for VS Code has been updated. View the release notes?", - "DocumentDB for VS Code is not signed in to Azure": "DocumentDB for VS Code is not signed in to Azure", "DocumentDB is still initializing. Keep waiting, view the logs, or start over.": "DocumentDB is still initializing. Keep waiting, view the logs, or start over.", "DocumentDB Kubernetes Operator (DKO)": "DocumentDB Kubernetes Operator (DKO)", "DocumentDB Local": "DocumentDB Local", @@ -1230,7 +1227,7 @@ "Host": "Host", "Hosts": "Hosts", "How do you want to connect?": "How do you want to connect?", - "How satisfied are you with DocumentDB for VS Code?": "How satisfied are you with DocumentDB for VS Code?", + "How satisfied are you with the DocumentDB extension?": "How satisfied are you with the DocumentDB extension?", "How should conflicts be handled during the copy operation?": "How should conflicts be handled during the copy operation?", "How to connect to ClusterIP / port-forwarded targets": "How to connect to ClusterIP / port-forwarded targets", "How to process your multi-line text?": "How to process your multi-line text?", @@ -1650,6 +1647,7 @@ "Not running": "Not running", "Not set up": "Not set up", "Not signed in to {0}. Please authenticate first.": "Not signed in to {0}. Please authenticate first.", + "Not signed in to Azure": "Not signed in to Azure", "Not supported yet": "Not supported yet", "Note: This confirmation type can be configured in the extension settings.": "Note: This confirmation type can be configured in the extension settings.", "Note: You can disable these URL handling confirmations in the extension settings.": "Note: You can disable these URL handling confirmations in the extension settings.", @@ -2312,6 +2310,7 @@ "The DocumentDB container stopped before it was ready (exit code {0}). View the setup log for details.": "The DocumentDB container stopped before it was ready (exit code {0}). View the setup log for details.", "The DocumentDB container stopped before it was ready: {0}. View the setup log for details.": "The DocumentDB container stopped before it was ready: {0}. View the setup log for details.", "The DocumentDB container stopped before it was ready. View the setup log for details.": "The DocumentDB container stopped before it was ready. View the setup log for details.", + "The DocumentDB extension has been updated. View the release notes?": "The DocumentDB extension has been updated. View the release notes?", "The DocumentDB Local container and its data are no longer in Docker, so setup creates a new, empty instance. If you switched Docker to a different engine or context, switch back and refresh DocumentDB Local in the Connections view instead.": "The DocumentDB Local container and its data are no longer in Docker, so setup creates a new, empty instance. If you switched Docker to a different engine or context, switch back and refresh DocumentDB Local in the Connections view instead.", "The DocumentDB Local container and its data were removed outside VS Code. Set it up again to create a new instance.": "The DocumentDB Local container and its data were removed outside VS Code. Set it up again to create a new instance.", "The DocumentDB Local container can no longer be managed because it was created outside the extension. Remove it with Docker if you no longer need it.": "The DocumentDB Local container can no longer be managed because it was created outside the extension. Remove it with Docker if you no longer need it.", @@ -2494,7 +2493,7 @@ "TypeScript-powered completions are unavailable on this read-only extension install. Click to retry.": "TypeScript-powered completions are unavailable on this read-only extension install. Click to retry.", "Unable to connect to the local database instance. Make sure it is started correctly. See {link} for tips.": "Unable to connect to the local database instance. Make sure it is started correctly. See {link} for tips.", "Unable to connect to the local instance. Make sure it is started correctly. See {link} for tips.": "Unable to connect to the local instance. Make sure it is started correctly. See {link} for tips.", - "Unable to load tenants. See the DocumentDB for VS Code output for details.": "Unable to load tenants. See the DocumentDB for VS Code output for details.", + "Unable to load tenants. See the DocumentDB output for details.": "Unable to load tenants. See the DocumentDB output for details.", "Unable to parse the document _id. See the output channel for details.": "Unable to parse the document _id. See the output channel for details.", "Unable to retrieve credentials for cluster \"{cluster}\".": "Unable to retrieve credentials for cluster \"{cluster}\".", "Unable to retrieve credentials for the selected cluster.": "Unable to retrieve credentials for the selected cluster.", @@ -2733,7 +2732,7 @@ "You return only {0}% of examined documents.\n\nThis indicates poor query selectivity: the database examines many documents that do not match your query criteria.\n\nConsider adding more selective indexes or refining your query filters.": "You return only {0}% of examined documents.\n\nThis indicates poor query selectivity: the database examines many documents that do not match your query criteria.\n\nConsider adding more selective indexes or refining your query filters.", "You return only {0}% of examined documents.\n\nThis is extremely inefficient - the database examines thousands of documents for each result returned.\n\nThis severely impacts performance and should be addressed with better indexing strategies.": "You return only {0}% of examined documents.\n\nThis is extremely inefficient - the database examines thousands of documents for each result returned.\n\nThis severely impacts performance and should be addressed with better indexing strategies.", "You're attempting to copy a large number of documents. This process can be slow because it downloads all documents from the source to your computer and then uploads them to the destination, which can take a significant amount of time and bandwidth.\n\nFor larger data migrations, we recommend using a dedicated migration tool for a faster experience.\n\nNote: You can disable this warning or adjust the document count threshold in the extension settings.": "You're attempting to copy a large number of documents. This process can be slow because it downloads all documents from the source to your computer and then uploads them to the destination, which can take a significant amount of time and bandwidth.\n\nFor larger data migrations, we recommend using a dedicated migration tool for a faster experience.\n\nNote: You can disable this warning or adjust the document count threshold in the extension settings.", - "You've used DocumentDB for VS Code on {0} days, so we'd love to hear how it's going. This count stays on your device.": "You've used DocumentDB for VS Code on {0} days, so we'd love to hear how it's going. This count stays on your device.", + "You've used the DocumentDB extension on {0} days, so we'd love to hear how it's going. This count stays on your device.": "You've used the DocumentDB extension on {0} days, so we'd love to hear how it's going. This count stays on your device.", "Your account lacks permission to list services in this namespace.": "Your account lacks permission to list services in this namespace.", "Your account lacks the required RBAC permissions. Contact your cluster administrator.": "Your account lacks the required RBAC permissions. Contact your cluster administrator.", "Your clipboard contents will be saved as a kubeconfig source.": "Your clipboard contents will be saved as a kubeconfig source.", diff --git a/package-lock.json b/package-lock.json index 64aa8a2f6..1c323b19f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "vscode-documentdb", - "version": "1.0.0", + "version": "1.0.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "vscode-documentdb", - "version": "1.0.0", + "version": "1.0.1", "license": "SEE LICENSE IN LICENSE.md", "workspaces": [ "packages/*" diff --git a/package.json b/package.json index 7843d48ae..a9a9b32df 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,10 @@ { "name": "vscode-documentdb", - "version": "1.0.0", + "version": "1.0.1", "releaseNotesUrl": "https://github.com/microsoft/vscode-documentdb/discussions/1012", "aiKey": "0c6ae279ed8443289764825290e4f9e2-1a736e7c-1324-4338-be46-fc2a58ae4d14-7255", "publisher": "ms-azuretools", - "displayName": "DocumentDB for VS Code", + "displayName": "DocumentDB", "description": "DocumentDB GUI and MongoDB GUI for Azure DocumentDB, DocumentDB and MongoDB (including Atlas): connect, query and manage your data, in the cloud or locally.", "enableMongoClusters": true, "engines": { @@ -32,6 +32,8 @@ "MongoDB", "DocumentDB", "Azure DocumentDB", + "DocumentDB extension", + "DocumentDB for VS Code", "MongoDB Atlas", "Cosmos DB", "Mongo", @@ -2179,7 +2181,7 @@ "walkthroughs": [ { "id": "documentdb-welcome", - "title": "Get Started with DocumentDB for VS Code", + "title": "Get Started with DocumentDB", "description": "The DocumentDB GUI and MongoDB GUI for Azure DocumentDB, DocumentDB and MongoDB. Connect, explore, query and move your data without leaving VS Code.", "steps": [ { diff --git a/packages/documentdb-js-shell-runtime/CHANGELOG.md b/packages/documentdb-js-shell-runtime/CHANGELOG.md index 6884b441a..d9cce3128 100644 --- a/packages/documentdb-js-shell-runtime/CHANGELOG.md +++ b/packages/documentdb-js-shell-runtime/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## Unreleased + +- The default `productName` is now `DocumentDB` (was `DocumentDB for VS Code`). It only appears on the OIDC browser sign-in page. + ## 0.9.0 ### Breaking changes diff --git a/packages/documentdb-js-shell-runtime/src/DocumentDBServiceProvider.ts b/packages/documentdb-js-shell-runtime/src/DocumentDBServiceProvider.ts index a4b551744..b97efb924 100644 --- a/packages/documentdb-js-shell-runtime/src/DocumentDBServiceProvider.ts +++ b/packages/documentdb-js-shell-runtime/src/DocumentDBServiceProvider.ts @@ -7,7 +7,7 @@ import { NodeDriverServiceProvider } from '@mongosh/service-provider-node-driver import { EventEmitter } from 'events'; import { type MongoClient } from 'mongodb'; -const DEFAULT_PRODUCT_NAME = 'DocumentDB for VS Code'; +const DEFAULT_PRODUCT_NAME = 'DocumentDB'; const DEFAULT_PRODUCT_DOCS_LINK = 'https://github.com/microsoft/vscode-documentdb'; /** diff --git a/packages/documentdb-js-shell-runtime/src/DocumentDBShellRuntime.ts b/packages/documentdb-js-shell-runtime/src/DocumentDBShellRuntime.ts index 27418cbd3..654a435e0 100644 --- a/packages/documentdb-js-shell-runtime/src/DocumentDBShellRuntime.ts +++ b/packages/documentdb-js-shell-runtime/src/DocumentDBShellRuntime.ts @@ -26,7 +26,7 @@ import { const DIRECT_COMMAND_LINE_RE = /^(\s*)(use|show)\s+([^(\s][^;]*?)\s*;?\s*$/; const DEFAULT_OPTIONS: ShellRuntimeOptions = { - productName: 'DocumentDB for VS Code', + productName: 'DocumentDB', productDocsLink: 'https://github.com/microsoft/vscode-documentdb', displayBatchSize: 50, persistent: false, diff --git a/packages/vscode-ext-webview-fluentui/README.md b/packages/vscode-ext-webview-fluentui/README.md index 09c7800dc..0b2b58f93 100644 --- a/packages/vscode-ext-webview-fluentui/README.md +++ b/packages/vscode-ext-webview-fluentui/README.md @@ -6,7 +6,7 @@ active VS Code theme, a small set of **reusable components** that Fluent itself **Monaco theming** that paints the editor from the same colors, so the two engines agree. All three were extracted from the webview stack that ships in the battle-tested -[DocumentDB for VS Code](https://github.com/microsoft/vscode-documentdb) extension, where they +[DocumentDB extension for Visual Studio Code](https://github.com/microsoft/vscode-documentdb), where they style the production collection, document, and query views that people use every day. Dropping in `VSCodeFluentProvider` is a one-line change; everything past that is optional. diff --git a/packages/vscode-ext-webview/README.md b/packages/vscode-ext-webview/README.md index c0aa93265..ac8a46d9c 100644 --- a/packages/vscode-ext-webview/README.md +++ b/packages/vscode-ext-webview/README.md @@ -9,9 +9,9 @@ Webview infrastructure for VS Code extensions: type-safe tRPC over transport, optional React hooks for the webview side, and pluggable telemetry. The transport was extracted from the webview stack that ships in the -battle-tested [DocumentDB for VS Code](https://github.com/microsoft/vscode-documentdb) -and [Azure Cosmos DB for VS Code](https://github.com/microsoft/vscode-cosmosdb) -extensions, where it powers the production collection, document, and query +battle-tested [DocumentDB extension for Visual Studio Code](https://github.com/microsoft/vscode-documentdb) +and the [Azure Cosmos DB for VS Code](https://github.com/microsoft/vscode-cosmosdb) +extension, where it powers the production collection, document, and query experiences that people use every day. A companion [vscode-webview-starter-kit](https://github.com/tnaum-ms/vscode-webview-starter-kit) @@ -437,7 +437,7 @@ The `/webview` and `/react` entries run in the webview and are bundled with the webview application. The unbundled rows were verified on VS Code 1.109.0 and 1.115.0 (Linux) with the -packed package. DocumentDB for VS Code ships the bundled form and checks it in CI. +packed package. The DocumentDB extension ships the bundled form and checks it in CI. ## What's inside @@ -519,7 +519,7 @@ This package and the [vscode-webview-starter-kit](https://github.com/tnaum-ms/vs built alongside it were a team effort: - [**tnaum-ms**](https://github.com/tnaum-ms) extracted the package from the - webview stack that ships in DocumentDB for VS Code, shaped the tRPC + webview stack that ships in the DocumentDB extension, shaped the tRPC integration and public API, and built the companion starter kit. - [**bk201-**](https://github.com/bk201-) built the dynamic theming system and, with sevoku, test-drove the package in [Azure Cosmos DB for VS Code](https://github.com/microsoft/vscode-cosmosdb), diff --git a/src/commands/addConnectionFromRegistry/addConnectionFromRegistry.ts b/src/commands/addConnectionFromRegistry/addConnectionFromRegistry.ts index d5e0b3fdf..21efa7d61 100644 --- a/src/commands/addConnectionFromRegistry/addConnectionFromRegistry.ts +++ b/src/commands/addConnectionFromRegistry/addConnectionFromRegistry.ts @@ -56,7 +56,7 @@ export async function addConnectionFromRegistry(context: IActionContext, node: C // Show a modal dialog informing the user that the details will be saved for future use const continueButton = l10n.t('Yes, continue'); const message = l10n.t( - 'Connection: "{selectedConnectionName}"\n\nThe connection will be added to the "Connections View" in the "DocumentDB for VS Code" extension. The "Connections View" will be opened once this process completes.\n\nDo you want to continue?', + 'Connection: "{selectedConnectionName}"\n\nThe connection will be added to the "Connections View" in the DocumentDB extension. The "Connections View" will be opened once this process completes.\n\nDo you want to continue?', { selectedConnectionName: node.cluster.name, }, diff --git a/src/commands/newConnection/PromptTenantStep.ts b/src/commands/newConnection/PromptTenantStep.ts index 1850c3efd..7595c0fe1 100644 --- a/src/commands/newConnection/PromptTenantStep.ts +++ b/src/commands/newConnection/PromptTenantStep.ts @@ -66,7 +66,7 @@ export class PromptTenantStep extends AzureWizardPromptStep): onLog: log, }, { - productName: 'DocumentDB for VS Code Query Playground', + productName: 'DocumentDB Query Playground', productDocsLink: 'https://github.com/microsoft/vscode-documentdb', persistent: msg.persistent ?? false, }, diff --git a/src/extension.ts b/src/extension.ts index 99ad49f0b..51bc45cf5 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -48,7 +48,7 @@ export async function activateInternal( // TreeElementStateManager is needed here too ext.state = new TreeElementStateManager(); - ext.outputChannel = createAzExtLogOutputChannel('DocumentDB for VS Code'); + ext.outputChannel = createAzExtLogOutputChannel('DocumentDB'); context.subscriptions.push(ext.outputChannel); ext.playgroundOutputChannel = vscode.window.createOutputChannel('DocumentDB Query Playground Output'); diff --git a/src/plugins/api-shared/azure/credentialsManagement/SelectAccountStep.ts b/src/plugins/api-shared/azure/credentialsManagement/SelectAccountStep.ts index c3c00759b..3d92b5027 100644 --- a/src/plugins/api-shared/azure/credentialsManagement/SelectAccountStep.ts +++ b/src/plugins/api-shared/azure/credentialsManagement/SelectAccountStep.ts @@ -81,7 +81,7 @@ export class SelectAccountStep extends AzureWizardPromptStep { }; const selectedButton = await vscode.window.showInformationMessage( - vscode.l10n.t('DocumentDB for VS Code has been updated. View the release notes?'), + vscode.l10n.t('The DocumentDB extension has been updated. View the release notes?'), releaseNotesButton, remindLaterButton, ignoreButton, diff --git a/src/services/survey/invitation/SurveyInvitationView.ts b/src/services/survey/invitation/SurveyInvitationView.ts index 47df32019..35a6a1222 100644 --- a/src/services/survey/invitation/SurveyInvitationView.ts +++ b/src/services/survey/invitation/SurveyInvitationView.ts @@ -314,8 +314,8 @@ export async function initializeSurveyInvitation( export function getSurveyInvitationStrings(): SurveyInvitationStrings { return { language: vscode.env.language, - title: vscode.l10n.t('DocumentDB for VS Code'), - question: vscode.l10n.t('How satisfied are you with DocumentDB for VS Code?'), + title: vscode.l10n.t('DocumentDB'), + question: vscode.l10n.t('How satisfied are you with the DocumentDB extension?'), stars: [ vscode.l10n.t('Very dissatisfied'), vscode.l10n.t('Dissatisfied'), @@ -330,7 +330,7 @@ export function getSurveyInvitationStrings(): SurveyInvitationStrings { neverAgain: vscode.l10n.t("Don't ask again"), why: vscode.l10n.t('Why am I seeing this?'), usage: vscode.l10n.t( - "You've used DocumentDB for VS Code on {0} days, so we'd love to hear how it's going. This count stays on your device.", + "You've used the DocumentDB extension on {0} days, so we'd love to hear how it's going. This count stays on your device.", ), manuallyOpened: vscode.l10n.t( "You opened this with Give Feedback. Thank you for taking a moment to tell us how it's going.", diff --git a/src/services/survey/invitation/surveyInvitationHtml.test.ts b/src/services/survey/invitation/surveyInvitationHtml.test.ts index a9d592b6c..033605c40 100644 --- a/src/services/survey/invitation/surveyInvitationHtml.test.ts +++ b/src/services/survey/invitation/surveyInvitationHtml.test.ts @@ -13,8 +13,8 @@ const { DOMParser } = window; const strings: SurveyInvitationStrings = { language: 'en', - title: 'DocumentDB for VS Code', - question: 'Overall, how satisfied are you with DocumentDB for VS Code?', + title: 'DocumentDB', + question: 'Overall, how satisfied are you with the DocumentDB extension?', stars: ['Very dissatisfied', 'Dissatisfied', 'Neutral', 'Satisfied', 'Very satisfied'], openSurvey: 'Continue to survey', browserNote: "You'll answer this question in the external form in your browser.", @@ -22,7 +22,7 @@ const strings: SurveyInvitationStrings = { askLater: 'Ask me later', neverAgain: 'Never again', why: 'Why am I seeing this?', - usage: "You've used DocumentDB for VS Code on {0} days with meaningful extension use. This count stays on your device.", + usage: "You've used the DocumentDB extension on {0} days with meaningful extension use. This count stays on your device.", manuallyOpened: "You're seeing this because you opened the feedback form.", close: 'Close', manualTelemetry: 'We record survey opening only when feedback telemetry is permitted.', @@ -86,13 +86,9 @@ function interactiveHtml(): { } describe('survey invitation HTML', (): void => { - it('keeps the title suffix together while allowing a break after DocumentDB', (): void => { + it('shows the product name as the heading and the page title', (): void => { const page = parseHtml(html()); - const title = page.querySelector('h1'); - expect(title?.textContent).toBe(strings.title); - expect(title?.firstChild?.textContent).toBe('DocumentDB '); - expect(title?.querySelector('.title-suffix')?.textContent).toBe('for VS Code'); - expect(page.querySelector('style')?.textContent).toContain('.title-suffix { white-space: nowrap; }'); + expect(page.querySelector('h1')?.textContent).toBe(strings.title); expect(page.querySelector('title')?.textContent).toBe(strings.title); }); diff --git a/src/services/survey/invitation/surveyInvitationHtml.ts b/src/services/survey/invitation/surveyInvitationHtml.ts index 0a16636d6..4fa59a43f 100644 --- a/src/services/survey/invitation/surveyInvitationHtml.ts +++ b/src/services/survey/invitation/surveyInvitationHtml.ts @@ -58,7 +58,7 @@ function escapeHtml(value: string): string { export function buildSurveyInvitationHtml(options: SurveyInvitationHtmlOptions): string { const { explanation, manuallyOpened, strings, nonce, cspSource, artworkUri, artworkDarkUri } = options; const text = escapeHtml; - const title = text(strings.title).replace('for VS Code', 'for VS Code'); + const title = text(strings.title); const usage = manuallyOpened ? strings.manuallyOpened : strings.usage.replaceAll('{0}', String(explanation.activeDayCount)); @@ -93,7 +93,6 @@ img { flex: 0 0 auto; width: 36px; height: 36px; object-fit: contain; } body.vscode-dark .logo-light, body.vscode-high-contrast:not(.vscode-high-contrast-light) .logo-light { display: none; } body.vscode-dark .logo-dark, body.vscode-high-contrast:not(.vscode-high-contrast-light) .logo-dark { display: block; } h1 { flex: 1 1 auto; min-width: 0; font-size: 18px; font-weight: 600; line-height: 24px; margin: 0; } -.title-suffix { white-space: nowrap; } .content { max-width: 480px; margin: 0 auto; padding: 24px 16px; } h2 { font-size: 16px; font-weight: 600; line-height: 24px; margin: 0; } p { margin: 8px 0; } diff --git a/src/services/taskService/README.md b/src/services/taskService/README.md index f096feb2b..a11fbe0d2 100644 --- a/src/services/taskService/README.md +++ b/src/services/taskService/README.md @@ -1,6 +1,6 @@ # Task Service Architecture -Technical documentation for the Task Service framework, which provides long-running background task management for the DocumentDB VS Code extension. +Technical documentation for the Task Service framework, which provides long-running background task management for the DocumentDB extension for Visual Studio Code. --- diff --git a/src/tree/README.md b/src/tree/README.md index 3868a897d..5f1941a5d 100644 --- a/src/tree/README.md +++ b/src/tree/README.md @@ -2,7 +2,7 @@ _Last update: April 30, 2025_ -This directory contains the tree view implementations for the DocumentDB for VS Code extension. The extension provides multiple ways to visualize and interact with CosmosDB resources. +This directory contains the tree view implementations for the DocumentDB extension for Visual Studio Code. The extension provides multiple ways to visualize and interact with CosmosDB resources. ## View Types diff --git a/src/tree/azure-workspace-view/SwitchToDocumentDbItem.ts b/src/tree/azure-workspace-view/SwitchToDocumentDbItem.ts index 0dcb6341c..dc2ad4d6e 100644 --- a/src/tree/azure-workspace-view/SwitchToDocumentDbItem.ts +++ b/src/tree/azure-workspace-view/SwitchToDocumentDbItem.ts @@ -20,7 +20,7 @@ export class SwitchToDocumentDbItem implements TreeElement, TreeElementWithConte public getTreeItem(): vscode.TreeItem { const tooltip = new vscode.MarkdownString( l10n.t( - 'The "MongoDB Connections" functionality has moved to the "DocumentDB for VS Code" extension.\n\n' + + 'The "MongoDB Connections" functionality has moved to the "DocumentDB extension for Visual Studio Code".\n\n' + 'If you had connections saved here in the past, they have been migrated to the new "Connections View".\n\n' + 'Click to switch to the new view.', ),