Clarify telemetry opt-out values - #46110
sanzanazaman wants to merge 1 commit into
Conversation
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
UmeshCode1
left a comment
There was a problem hiding this comment.
This is a great clarification.
The previous phrasing ("Any falsy value works: 0, false, disabled, or an empty string. You can also use the DO_NOT_TRACK convention:") could easily mislead users into assuming DO_NOT_TRACK also required a falsy value to opt out, when in fact the DO_NOT_TRACK=1 / true console standard requires a truthy value to disable tracking.
Explicitly delineating the active opt-out values for both environment variables (GH_TELEMETRY falsy vs DO_NOT_TRACK truthy) resolves that ambiguity cleanly. Content linters and Playwright test suite are green. LGTM!
|
As I noted here, we're not accepting contributions for this at this time, so I'm going to close this out |
|
Thanks for clarifying! |
Why:
The current wording does not make clear that DO_NOT_TRACK accepts only true or 1.
Closes: #45957
What's being changed (if available, include any code snippets, screenshots, or gifs):
Clarifies the documented opt-out values for GH_TELEMETRY and DO_NOT_TRACK in the GitHub CLI telemetry article. The values were checked against the GitHub CLI environment variable reference.
Check off the following: