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

Offen Anfängerfreundlich
#45,957 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
90/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github, shell
Bereich
cli, documentation

Rechercherichtung

Öffne den verlinkten Telemetrieartikel auf docs.github.com zu GitHub CLI und finde den Abschnitt zu Umgebungsvariablen „How to opt out“. Vergleiche die Formulierung mit der verlinkten Referenz cli/cli internal/telemetry/telemetry.go ungefähr bei Zeile 128. Kläre anschließend, welche DO_NOT_TRACK-Werte die Telemetrie deaktivieren, und überprüfe, dass das Beispiel weiterhin korrekt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
TypeScript
Sterne
20.9k
Forks
68.8k
Ø Merge
13 Std. 55 Min.
Gemergte PRs (30 T.)
105

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/docs

Alle Issues in github/docs

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.