-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): Add docs for Nx Console telemetry (#16062)
- Loading branch information
Showing
5 changed files
with
92 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
## Nx Console Telemetry | ||
|
||
To ensure that we focus on creating features that benefit your day-to-day workflow, we collect some data from the Nx Console extensions. | ||
|
||
## Collected Data | ||
|
||
Here's the information we collect for each extension. | ||
|
||
### User Data | ||
|
||
> None of the information that we ask for is used to track any personal information | ||
| Property | Description | | ||
| ----------- | ----------------------------------------------------------------------------------------- | | ||
| Client ID | These are retrieved by APIs provided by each editor. We do not generate this information. | | ||
| User ID | We use the same value as the Client ID | | ||
| Session ID | Generated UUID | | ||
| OS | What operating system are you using? | | ||
| Editor | What editor are you using? Visual Studio Code, Intellij, etc | | ||
| App Version | What version of the extension is being used? | | ||
|
||
### Event Data | ||
|
||
| Property | Description | | ||
| ------------------- | ---------------------------------- | | ||
| Extension Activated | Extension activation timings | | ||
| Action Triggered | Nx Generate, Nx Run, Nx Graph, etc | | ||
|
||
## Visual Studio Code | ||
|
||
For Visual Studio Code, we use the global telemetry setting provided by the editor. This is controlled by the `telemetry.telemetryLevel` setting | ||
|
||
#### How to Disable telemetry for Visual Studio Code | ||
|
||
Setting `telemetry.telemetryLevel` to `off` will disable telemetry for Nx Console in Visual Studio Code. Read more about the telemetry settings in Visual Studio Code [here](https://code.visualstudio.com/docs/getstarted/telemetry#_disable-telemetry-reporting) | ||
|
||
## Jetbrains (IntelliJ, Webstorm, etc) | ||
|
||
When the plugin is first installed, we will prompt you to opt in or out of reporting telemetry. | ||
|
||
#### How to Disable Telemetry for Jetbrains editors | ||
|
||
To turn off telemetry after opting in, go to **Settings** > **Tools** > **Nx Console** > Uncheck **Enable Telemetry** |
762dd1d
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
nx-dev – ./
nx-dev-git-master-nrwl.vercel.app
nx-dev-nrwl.vercel.app
nx-five.vercel.app
nx.dev