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

Abierto Apto para principiantes
#45,957 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
90/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
github, shell
Área
cli, documentation

Línea de trabajo

Abre el artículo enlazado sobre la telemetría de GitHub CLI en docs.github.com y localiza la sección de variables de entorno “How to opt out”. Compara la redacción con la referencia enlazada de cli/cli internal/telemetry/telemetry.go alrededor de la línea 128, luego aclara qué valores de DO_NOT_TRACK deshabilitan la telemetría y verifica que el ejemplo siga siendo correcto.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
TypeScript
Estrellas
20.9k
Forks
68.8k
Merge medio
13 h 55 min
PR fusionados (30 d)
105

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/docs

Todos los issues de github/docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.