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

Ouverte Adaptée aux débutants
#45,957 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
90/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
github, shell
Domaine
cli, documentation

Piste de recherche

Ouvrez l’article lié de docs.github.com sur la télémétrie de GitHub CLI et repérez la section sur les variables d’environnement « How to opt out ». Comparez la formulation avec la référence liée cli/cli internal/telemetry/telemetry.go autour de la ligne 128, puis précisez quelles valeurs de DO_NOT_TRACK désactivent la télémétrie et vérifiez que l’exemple reste exact.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

builder persona content
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

Langage dominant
TypeScript
Étoiles
20.9k
Forks
68.8k
Merge moyen
15 h 4 min
PR mergées (30 j)
103

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de github/docs

Toutes les issues de github/docs

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.