_content/doc: improve visibility of configuration in telemetry documentation

A common use-case for reading the telemetry documentation is to discover
how to enable or disable telemetry, yet the configuration section is
somewhat far down the page.

Add a new info callout with quick commands to enable or disable
telemetry.

For golang/go#68204

Change-Id: I6efc366401e626ed436905bda35fe75ae1c4bc57
Reviewed-on: https://go-review.googlesource.com/c/website/+/598695
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
This commit is contained in:
Rob Findley 2024-07-16 18:47:20 +00:00 коммит произвёл Robert Findley
Родитель d4aafd8e14
Коммит 822132964e
1 изменённых файлов: 32 добавлений и 1 удалений

Просмотреть файл

@ -5,6 +5,22 @@ breadcrumb: true
date: 2024-02-07:00:00Z date: 2024-02-07:00:00Z
--- ---
<style>
.DocInfo {
background-color: var(--color-background-info);
padding: 1.5rem 2rem 1.5rem 4rem;
border-left: 0.875rem solid var(--color-border);
position: relative;
}
.DocInfo:before {
content: "ⓘ";
position: absolute;
top: 1rem;
left: 1rem;
font-size: 2rem;
}
</style>
Table of Contents: Table of Contents:
[Background](#background)\ [Background](#background)\
@ -45,6 +61,19 @@ To learn more about telemetry and privacy, please see the
This page explains how Go telemetry works, in some detail. For quick answers to This page explains how Go telemetry works, in some detail. For quick answers to
frequently asked questions, see the [FAQ](#faq). frequently asked questions, see the [FAQ](#faq).
<div class="DocInfo">
To <strong>opt-in</strong> to uploading telemetry data to the Go team, run:
<pre>
go run golang.org/x/telemetry/cmd/gotelemetry@latest on
</pre>
To completely disable telemetry, including local collection, run:
<pre>
go run golang.org/x/telemetry/cmd/gotelemetry@latest off
</pre>
Starting with Go 1.23, this can also be done with the <code>go telemetry</code>
subcommand. See <a href="#config">Configuration</a> for more details.
</div>
## Overview {#overview} ## Overview {#overview}
Go telemetry uses three core data types: Go telemetry uses three core data types:
@ -105,7 +134,9 @@ The following commands interact with the telemetry mode:
For the complete usage information of the `gotelemetry` command line tool, For the complete usage information of the `gotelemetry` command line tool,
see its [package documentation](/pkg/golang.org/x/telemetry/cmd/gotelemetry). see its [package documentation](/pkg/golang.org/x/telemetry/cmd/gotelemetry).
Telemetry may also be enabled by accepting an [IDE prompt](#ide). Starting with Go 1.23, the telemetry mode can also be managed with the
`go telemetry` subcommand. Telemetry may also be enabled by accepting an
[IDE prompt](#ide).
## Counters {#counters} ## Counters {#counters}