Skip to content

Commit 4dd1be5

Browse files
committed
Polish headings and formatting
1 parent 28848ec commit 4dd1be5

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

docs/codeql/codeql-for-visual-studio-code/about-telemetry-in-codeql-for-visual-studio-code.rst

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55
About telemetry in CodeQL for Visual Studio Code
66
=================================================
77

8-
If you specifically opt-in to permit GitHub to do so, GitHub will collect usage data and metrics for the purposes of helping the core developers to improve the CodeQL extension for VS Code. This data will not be shared with any parties outside of GitHub. IP addresses and installation IDs will be retained for a maximum of 30 days. Anonymous data will be retained for a maximum of 180 days.
8+
If you specifically opt in to permit GitHub to do so, GitHub will collect usage data and metrics for the purposes of helping the core developers to improve the CodeQL extension for VS Code.
99

10-
Why do you collect data?
10+
This data will not be shared with any parties outside of GitHub. IP addresses and installation IDs will be retained for a maximum of 30 days. Anonymous data will be retained for a maximum of 180 days.
11+
12+
Why we collect data
1113
--------------------------------------
1214

1315
GitHub collects aggregated, anonymous usage data and metrics to help us improve CodeQL for VS Code. IP addresses and installation IDs are collected only to ensure that anonymous data is not duplicated during aggregation.
@@ -17,43 +19,44 @@ What data is collected
1719

1820
If you opt in, GitHub collects the following information related to the usage of the extension. The data collected are:
1921

20-
- The identifiers of any CodeQL-related `VS Code commands <https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_command-palette>`__ that are run
21-
- For each command: the timestamp, time taken, and whether or not the command completed successfully
22-
- VS Code and extension version
22+
- The identifiers of any CodeQL-related VS Code commands that are run.
23+
- For each command: the timestamp, time taken, and whether or not the command completed successfully.
24+
- VS Code and extension version.
2325
- Randomly generated GUID that uniquely identifies a CodeQL extension installation. (Discarded before aggregation.)
2426
- IP address of the client sending the telemetry data. (Discarded before aggregation.)
25-
- Whether or not the ``codeQL.canary`` setting is enabled and set to `true`
27+
- Whether or not the ``codeQL.canary`` setting is enabled and set to ``true``.
2628

27-
How long will data be retained?
28-
--------------------------------------
29+
How long data is retained
30+
--------------------------
2931

3032
IP address and GUIDs will be retained for a maximum of 30 days. Anonymous, aggregated data that includes command identifiers, run times, and timestamps will be retained for a maximum of 180 days.
3133

32-
Who will have access to this data?
33-
--------------------------------------
34+
Access to the data
35+
-------------------
3436

3537
IP address and GUIDs will only be available to the core developers of CodeQL. Aggregated data will be available to GitHub employees.
3638

37-
What data is **NOT** collected?
38-
--------------------------------------
39+
What data is **NOT** collected
40+
--------------------------------
3941

4042
We only collect the minimal amount of data we need to answer the questions about how our users are experiencing this product. To that end, we do not collect the following information:
4143

4244
- No GitHub user ID
4345
- No CodeQL database names or contents
4446
- No contents of CodeQL queries
45-
- No filesystem paths.
47+
- No filesystem paths
4648

47-
How do I disable telemetry reporting?
48-
---------------------------------------------------------
49+
Disabling telemetry reporting
50+
------------------------------
4951

5052
When telemetry collection is disabled, no data will be sent to GitHub servers.
5153

52-
You can disable telemetry collection by setting ``codeQL.telemetry.enableTelemetry`` to ``false`` in `your settings <https://code.visualstudio.com/docs/getstarted/settings#_settings-editor>`__. Telemetry collection is _disabled_ by default.
54+
You can disable telemetry collection by setting ``codeQL.telemetry.enableTelemetry`` to ``false`` in your settings. For more information about CodeQL settings, see ":doc:`Customizing settings <customizing-settings>`."
55+
Telemetry collection is *disabled* by default.
5356

54-
Additionally, telemetry collection will be disabled if the global ``telemetry.enableTelemetry`` setting is set to ``false``. For more information on global telemetry collection, see `Microsofts documentation <https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting>`__.
57+
Additionally, telemetry collection will be disabled if the global ``telemetry.enableTelemetry`` setting is set to ``false``. For more information about global telemetry collection, see "`Microsoft's documentation <https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting>`__."
5558

56-
More information
57-
-------------------
59+
Further reading
60+
----------------
5861

59-
See GitHub's `Privacy Statement <https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-privacy-statement>`__ and `Terms of Service <https://docs.github.com/en/free-pro-team@latest/github/site-policy/github-terms-of-service>`__ for more information.
62+
For more information, see GitHub's "`Privacy Statement <https://docs.github.com/github/site-policy/github-privacy-statement>`__" and "`Terms of Service <https://docs.github.com/github/site-policy/github-terms-of-service>`__."

0 commit comments

Comments
 (0)