Clarify that `DO_NOT_TRACK` only disables telemetry if `1` or `true`

Aperta Adatta ai principianti
#45,957 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
90/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github, shell
Ambito
cli, documentation

Direzione di ricerca

Apri l’articolo collegato sulla telemetria di GitHub CLI su docs.github.com e individua la sezione sulle variabili d’ambiente “How to opt out”. Confronta la formulazione con il riferimento collegato cli/cli internal/telemetry/telemetry.go intorno alla riga 128, quindi chiarisci quali valori di DO_NOT_TRACK disabilitano la telemetria e verifica che l’esempio sia ancora corretto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

content triage
Code of Conduct
What article on docs.github.com is affected?

https://docs.github.com/en/github-cli/github-cli/github-cli-telemetry#how-to-opt-out

What part(s) of the article would you like to see updated?

The section on environment variables currently looks like this:

Environment variables:

export GH_TELEMETRY=false

Any falsy value works: 0, false, disabled, or an empty string. You can also use the DO_NOT_TRACK convention:

export DO_NOT_TRACK=true

Saying that any falsy value works for GH_TELEMETRY right before introducing DO_NOT_TRACK can create the implication that any truthy value would be accepted for DO_NOT_TRACK. I believe this is not the case though; it looks like DO_NOT_TRACK must be 1 or true. It would be nice to clarify this.

It also seems like most people set DO_NOT_TRACK to 1 anyway, so it would be good to be explicit for the opposite reason too; we don't want people to assume that only true is accepted.

Additional information

No response

Lingua principale
TypeScript
Stelle
20.9k
Fork
68.8k
Merge medio
13h 55m
PR unite (30g)
105

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/docs

Tutte le issue di github/docs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.