Docs (CodeQL for VS Code): Move info about telemetry into codeql.github.com

[shati-patel]

Summary

We'd like to move the information from TELEMETRY.md into the main docs set on codeql.github.com. The telemetry content was originally discussed and added in github/vscode-codeql#611. To avoid duplication, we'll now delete the TELEMETRY.md file from the vscode-codeql repo (see github/vscode-codeql#758).

Changes

48ace06 copies the original doc into the Sphinx project and 28848ec adds links to this new article.

👇🏽 This is the main commit to review 👇🏽

4dd1be5 contains editorial changes to the telemetry doc. I've kept most of the text as-is, since I didn't want to change the specific details around data collection etc.

I've provided a link to a preview in the internal (linked) issue.

[adityasharad]

Something to consider in future: should we have these extension docs files in the extension repo, so you don't have to manage cross repo coordination?

[aeisenberg]

The content looks good. My only question (as Aditya points out) is how we should manage duplication with the document in the vscode-codeql repo. I'd prefer to avoid duplication.

Either this PR goes in and we remove the file in the extension repo (also need to update links). Or, as Aditya suggests, we automate copying from that repo to here.

Either option is fine by me. If we go the route of hosting the docs here, I can open PRs in this repo when necessary on changing the telemetry docs.

[shati-patel]

Thanks for the reviews, @aeisenberg and @adityasharad!

Either this PR goes in and we remove the file in the extension repo (also need to update links). Or, as Aditya suggests, we automate copying from that repo to here.

I agree we should only have a single source file. At least for now, we'd like to have the docs all in one place in this repo (as much as possible) to avoid versioning difficulties and syncing branches/submodules across the various CodeQL-related repos 😅 You can open PRs here to update the telemetry policies.

As for removing the file in the extension repo, I can open a PR there too 🙂 codeql.github.com gets republished roughly every two weeks (in line with CodeQL CLI releases), so I can make sure to time the deletion of TELEMETRY.md accordingly.

Hope that makes sense!

[aeisenberg]

This should be fine for now, though a benefit of keeping the docs in a public repo is that users can view how the privacy policy has changed over time (by looking at the file history). If we keep the docs here, then we should explicitly call out any changes or updates to the file.

[shati-patel]

This should be fine for now, though a benefit of keeping the docs in a public repo is that users can view how the privacy policy has changed over time (by looking at the file history). If we keep the docs here, then we should explicitly call out any changes or updates to the file.

This repo is also public! 😃 I guess it makes the original discussion harder to find, but here's a link for future reference: github/vscode-codeql#611 (I'll this link to the OP as well so people can see it at a glance.)

[mchammer01]

@shati-patel - this LGTM, thanks doing this work so quickly ⚡ ✨
I've made a couple of very minor comments.