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

オープン 初心者向け
#45,957 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
90/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
github, shell
領域
cli, documentation

調査の方向性

docs.github.com にリンクされている GitHub CLI のテレメトリに関する記事を開き、環境変数のセクション「How to opt out」を見つけてください。リンクされている cli/cli internal/telemetry/telemetry.go の 128 行目付近のリファレンスと文言を比較し、どの DO_NOT_TRACK の値でテレメトリが無効になるのかを明確にして、例が引き続き正確であることを確認してください。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
TypeScript
スター
20.9k
フォーク
68.8k
平均マージ
15時間 4分
マージ済み PR（30日）
103

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/docs のほかの issue

github/docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。