Skip to content

Commit b27bf1e

Browse files
authored
Merge pull request #9817 from microsoft/ntrogh/faq-settings
Add settings syntax to FAQ article
2 parents ce093fb + e1b765b commit b27bf1e

1 file changed

Lines changed: 19 additions & 14 deletions

File tree

docs/supporting/faq.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -126,25 +126,25 @@ Yes, VS Code has a [Portable Mode](/docs/editor/portable.md) that lets you keep
126126

127127
### How to disable telemetry reporting
128128

129-
VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](https://go.microsoft.com/fwlink/?LinkID=528096&clcid=0x409) and [telemetry documentation](/docs/getstarted/telemetry.md) to learn more.
129+
VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](https://go.microsoft.com/fwlink/?LinkID=528096&clcid=0x409) and [telemetry documentation](/docs/configure/telemetry.md) to learn more.
130130

131-
If you don't want to send usage data to Microsoft, you can set the `telemetry.telemetryLevel` user [setting](/docs/configure/settings.md) to `off`.
131+
If you don't want to send usage data to Microsoft, you can set the `setting(telemetry.telemetryLevel)` user [setting](/docs/configure/settings.md) to `off`.
132132

133133
From **File** > **Preferences** > **Settings**, search for `telemetry`, and set the **Telemetry: Telemetry Level** setting to `off`. This will silence all telemetry events from VS Code going forward.
134134

135-
> **Important Notice**: VS Code gives you the option to install Microsoft and third party extensions. These extensions may be collecting their own usage data and are not controlled by the `telemetry.telemetryLevel` setting. Consult the specific extension's documentation to learn about its telemetry reporting.
135+
> **Important Notice**: VS Code gives you the option to install Microsoft and third party extensions. These extensions may be collecting their own usage data and are not controlled by the `setting(telemetry.telemetryLevel)` setting. Consult the specific extension's documentation to learn about its telemetry reporting.
136136
137137
#### How to disable experiments
138138

139-
VS Code uses experiments to try out new features or progressively roll them out. Our experimentation framework calls out to a Microsoft-owned service and is therefore disabled when telemetry is disabled. However, if you want to disable experiments regardless of your telemetry preferences, you may set the `workbench.enableExperiments` user [setting](/docs/configure/settings.md) to `false`.
139+
VS Code uses experiments to try out new features or progressively roll them out. Our experimentation framework calls out to a Microsoft-owned service and is therefore disabled when telemetry is disabled. However, if you want to disable experiments regardless of your telemetry preferences, you may set the `setting(workbench.enableExperiments)` user [setting](/docs/configure/settings.md) to `false`.
140140

141141
From **File** > **Preferences** > **Settings**, search for `experiments`, and uncheck the **Workbench: Enable Experiments** setting. This will prevent VS Code from calling out to the service and opt out of any ongoing experiments.
142142

143143
### How to disable crash reporting
144144

145-
VS Code collects data about any crashes that occur and sends it to Microsoft to help improve our products and services. Read our [privacy statement](https://go.microsoft.com/fwlink/?LinkID=528096&clcid=0x409) and [telemetry documentation](/docs/getstarted/telemetry.md) to learn more.
145+
VS Code collects data about any crashes that occur and sends it to Microsoft to help improve our products and services. Read our [privacy statement](https://go.microsoft.com/fwlink/?LinkID=528096&clcid=0x409) and [telemetry documentation](/docs/configure/telemetry.md) to learn more.
146146

147-
If you don't want to send crash data to Microsoft, you can change the `telemetry.telemetryLevel` user [setting](/docs/configure/settings.md) to `off`.
147+
If you don't want to send crash data to Microsoft, you can change the `setting(telemetry.telemetryLevel)` user [setting](/docs/configure/settings.md) to `off`.
148148

149149
From **File** > **Preferences** > **Settings**, search for `telemetry`, and set the **Telemetry: Telemetry Level** setting to `off`. This will silence all telemetry events including crash reporting from VS Code. You will need to restart VS Code for the setting change to take effect.
150150

@@ -158,11 +158,11 @@ To support GDPR:
158158
* The team actively reviews and classifies all telemetry sent (documented in [our OSS codebase](https://github.com/microsoft/vscode/pull/34997)).
159159
* There are valid data retention policies in place for any data collected, for example crash dumps.
160160

161-
You can learn more about VS Code's GDPR compliance in the [telemetry documentation](/docs/getstarted/telemetry.md).
161+
You can learn more about VS Code's GDPR compliance in the [telemetry documentation](/docs/configure/telemetry.md).
162162

163163
## What online services does VS Code use?
164164

165-
Beyond crash reporting and telemetry, VS Code uses online services for various other purposes such as downloading product updates, finding, installing, and updating extensions, or providing Natural Language Search within the Settings editor. You can learn more in [Managing online services](/docs/getstarted/telemetry.md#managing-online-services).
165+
Beyond crash reporting and telemetry, VS Code uses online services for various other purposes such as downloading product updates, finding, installing, and updating extensions, or providing Natural Language Search within the Settings editor. You can learn more in [Managing online services](/docs/configure/telemetry.md#managing-online-services).
166166

167167
You can choose to turn on/off features that use these services. From **File** > **Preferences** > **Settings**, and type the tag `@tag:usesOnlineServices`. This will display all settings that control the usage of online services and you can individually switch them on or off.
168168

@@ -209,7 +209,7 @@ No. While the source code for an extension from Microsoft may be open source, we
209209

210210
We provide the Visual Studio Marketplace for use only by the Visual Studio family of products: Microsoft Visual Studio, Visual Studio Code, GitHub Codespaces, Azure DevOps, Azure DevOps Server, and successor products and services offered by us and Microsoft affiliates, such as GitHub, Inc. Therefore, alternative products including those built on a fork of the [Code - OSS Repository](https://github.com/microsoft/vscode), are not permitted to access the Visual Studio Marketplace. We do this to protect the security and quality of the ecosystem, including the following measures:
211211

212-
* Extensions run in the context and with the permissions of the product, and they might contain executable code. The [Marketplace vets every extension](/docs/editor/extension-runtime-security.md#marketplace-protections) for security and to prevent them from performing malicious activity. When you install an extension with a product in the Visual Studio family, you know that it has been vetted to run in that context.
212+
* Extensions run in the context and with the permissions of the product, and they might contain executable code. The [Marketplace vets every extension](/docs/configure/extensions/extension-runtime-security.md#marketplace-protections) for security and to prevent them from performing malicious activity. When you install an extension with a product in the Visual Studio family, you know that it has been vetted to run in that context.
213213

214214
* When a malicious extension is reported and verified, or a vulnerability is found in an extension dependency, the extension is removed from the Marketplace, added to a block list, and automatically uninstalled by VS Code.
215215

@@ -223,7 +223,7 @@ See [#31168](https://github.com/microsoft/vscode/issues/31168#issuecomment-28109
223223

224224
Installing extensions from the Visual Studio Marketplace has many advantages over installing them from other sources.
225225

226-
* The Visual Studio Marketplace employs [several mechanisms](/docs/editor/extension-runtime-security.md#marketplace-protections) to protect you from installing malicious extensions, including malware scanning, dynamic detection, publisher verification, and more. When you install extensions from a different source, there is no guarantee that the extension is safe to run in your context.
226+
* The Visual Studio Marketplace employs [several mechanisms](/docs/configure/extensions/extension-runtime-security.md#marketplace-protections) to protect you from installing malicious extensions, including malware scanning, dynamic detection, publisher verification, and more. When you install extensions from a different source, there is no guarantee that the extension is safe to run in your context.
227227

228228
* When a malicious extension is reported and verified, or a vulnerability is found in an extension dependency, the extension is removed from the Marketplace, added to a *block list*, and automatically uninstalled by VS Code.
229229

@@ -311,28 +311,33 @@ To install the Insiders build, go to the [Insiders download page](/insiders).
311311

312312
### How do I opt out of VS Code auto-updates?
313313

314-
By default, VS Code is set up to auto-update for macOS and Windows users when we release new updates. If you do not want to get automatic updates, you can set the **Update: Mode** setting from `default` to `none`.
314+
By default, VS Code is set up to auto-update for macOS and Windows users when we release new updates. If you do not want to get automatic updates, configure the **Update: Mode** setting (`setting(update.mode)`) from `default` to `none`.
315315

316316
To modify the update mode, go to **File** > **Preferences** > **Settings**, search for `update mode` and change the setting to `none`.
317317

318318
If you use the JSON editor for your settings, add the following line:
319319

320320
```json
321+
{
321322
"update.mode": "none"
323+
}
322324
```
323325

324326
You can install a previous release of VS Code by uninstalling your current version and then installing the download provided at the top of a specific [release notes](/updates) page.
325327

326-
>**Note:** On Linux: If the VS Code repository was installed correctly then your system package manager should handle auto-updating in the same way as other packages on the system. See [Installing VS Code on Linux](/docs/setup/linux.md).
328+
> [!NOTE]
329+
> On Linux: If the VS Code repository was installed correctly then your system package manager should handle auto-updating in the same way as other packages on the system. See [Installing VS Code on Linux](/docs/setup/linux.md).
327330
328331
#### Opt out of extension updates
329332

330-
By default, VS Code will also auto-update extensions as new versions become available. If you do not want extensions to automatically update, you can clear the **Extensions: Auto Update** check box in the Settings editor (`kb(workbench.action.openSettings)`).
333+
By default, VS Code will also auto-update extensions as new versions become available. If you do not want extensions to automatically update, you can clear the **Extensions: Auto Update** setting (`setting(extensions.autoUpdate)`) in the Settings editor (`kb(workbench.action.openSettings)`).
331334

332335
If you use the JSON editor to modify your settings, add the following line:
333336

334337
```json
338+
{
335339
"extensions.autoUpdate": false
340+
}
336341
```
337342

338343
## Where can I find the Visual Studio Code icons?
@@ -403,7 +408,7 @@ rm -r ~/.config/Code/GPUCache
403408

404409
### VS Code gets unresponsive right after opening a folder
405410

406-
When you open a folder, VS Code will search for typical project files to offer you additional tooling (for example, the solution picker in the Status bar to open a solution). If you open a folder with lots of files, the search can take a large amount of time and CPU resources during which VS Code might be slow to respond. We plan to improve this in the future but for now you can exclude folders from the explorer via the `files.exclude` setting and they will not be searched for project files:
411+
When you open a folder, VS Code will search for typical project files to offer you additional tooling (for example, the solution picker in the Status bar to open a solution). If you open a folder with lots of files, the search can take a large amount of time and CPU resources during which VS Code might be slow to respond. We plan to improve this in the future but for now you can exclude folders from the explorer via the `setting(files.exclude)` setting and they will not be searched for project files:
407412

408413
```json
409414
"files.exclude": {

0 commit comments

Comments
 (0)