.prettierrc.json: add prose wrap config
Enabled prose wrap to allow prettier to format the line
length in markdown files.
Change-Id: Ibdd0ada38bc0c394e5884df5c30e9286c810c74a
Reviewed-on: https://go-review.googlesource.com/c/telemetry/+/498259
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
Run-TryBot: Jamal Carvalho <jamal@golang.org>
Reviewed-by: Peter Weinberger <pjw@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
diff --git a/godev/.prettierrc.json b/godev/.prettierrc.json
index 0967ef4..91c0b94 100644
--- a/godev/.prettierrc.json
+++ b/godev/.prettierrc.json
@@ -1 +1 @@
-{}
+{"proseWrap": "always"}
diff --git a/godev/README.md b/godev/README.md
index fa06aa3..65ee33b 100644
--- a/godev/README.md
+++ b/godev/README.md
@@ -1,15 +1,15 @@
## TypeScript Support
-TypeScript files served from content directories are transformed into JavaScript.
-Reference .ts files in html templates as module code.
+TypeScript files served from content directories are transformed into
+JavaScript. Reference .ts files in html templates as module code.
`<script type="module" src="/filename.ts">`
## Linting & Formatting
This repository uses [eslint](https://eslint.org/) to format TS files,
-[stylelint](https://stylelint.io/) to format CSS files, and [prettier](https://prettier.io/)
-to format TS, CSS, Markdown, and YAML files.
+[stylelint](https://stylelint.io/) to format CSS files, and
+[prettier](https://prettier.io/) to format TS, CSS, Markdown, and YAML files.
See the style guides:
@@ -31,9 +31,9 @@
## Third Party
The `third_party` directory was generated with `go run ./devtools/cmd/npmdeps`.
-It contains JS packages that are served by the web site. To add or upgrade a
-new dependency use the necessary `./npm` command then run
+It contains JS packages that are served by the web site. To add or upgrade a new
+dependency use the necessary `./npm` command then run
`go run ./devtools/cmd/npmdeps`. Remove unnecessary files from the copy result
-where appropriate. For example, `content/localserver/index.html` only depends
-on files from `third_party/d3@7.8.4/dist/` so the directory
+where appropriate. For example, `content/localserver/index.html` only depends on
+files from `third_party/d3@7.8.4/dist/` so the directory
`third_party/d3@7.8.4/src` can be deleted.
diff --git a/godev/cmd/telemetrygodev/README.md b/godev/cmd/telemetrygodev/README.md
index 7bae7ca..78dad44 100644
--- a/godev/cmd/telemetrygodev/README.md
+++ b/godev/cmd/telemetrygodev/README.md
@@ -8,21 +8,24 @@
## Testing
-The telemetry.go.dev web site has a suite of regression tests that can be run with:
+The telemetry.go.dev web site has a suite of regression tests that can be run
+with:
go test golang.org/x/telemetry/...
## Deploying
-Each time a CL is reviewed and submitted, the site is automatically deployed to Cloud Run.
-If it passes its serving-readiness checks, it will be automatically promoted to handle traffic.
+Each time a CL is reviewed and submitted, the site is automatically deployed to
+Cloud Run. If it passes its serving-readiness checks, it will be automatically
+promoted to handle traffic.
-If the automatic deployment is not working, or to check on the status of a pending deployment,
-see the “telemetrygodev” trigger in the
+If the automatic deployment is not working, or to check on the status of a
+pending deployment, see the “telemetrygodev” trigger in the
[Cloud Build history](https://pantheon.corp.google.com/cloud-build/builds?project=go-telemetry).
### Test Instance
-To deploy a test instance of this service, push to a branch and manually trigger the deploy job from
-the [Cloud Build console](https://pantheon.corp.google.com/cloud-build/triggers?project=go-telemetry)
+To deploy a test instance of this service, push to a branch and manually trigger
+the deploy job from the
+[Cloud Build console](https://pantheon.corp.google.com/cloud-build/triggers?project=go-telemetry)
with the desired values for branch and service name.
diff --git a/godev/content/telemetrygodev/privacy.md b/godev/content/telemetrygodev/privacy.md
index 611e88e..c529fd8 100644
--- a/godev/content/telemetrygodev/privacy.md
+++ b/godev/content/telemetrygodev/privacy.md
@@ -6,11 +6,29 @@
_Last updated: April 27, 2023_
-When you enable Go toolchain telemetry using `go telemetry on`, Go toolchain programs such as the go command and gopls record usage and performance data about their own execution to local files on your computer stored in `os.UserConfigDir()/go/telemetry`. The files contain event counters, stack traces for the Go toolchain programs, and basic version information about your operating system, CPU architecture, and dependency tools such as the host C compiler and version control tools. The files do not contain any user data that may be potentially identifying or any kind of system identifier.
+When you enable Go toolchain telemetry using `go telemetry on`, Go toolchain
+programs such as the go command and gopls record usage and performance data
+about their own execution to local files on your computer stored in
+`os.UserConfigDir()/go/telemetry/local`. The files contain event counters, stack
+traces for the Go toolchain programs, and basic version information about your
+operating system, CPU architecture, and dependency tools such as the host C
+compiler and version control tools. The files do not contain any user data that
+may be potentially identifying or any kind of system identifier.
You can view the locally collected data using `go telemetry view`.
-Once a week, the Go toolchain will randomly decide whether to upload that week's reports to a server at Google. The random choice is set so that a representative sample of systems upload reports each week. As more systems participate, each system uploads less often. This data is collected in accordance with the Google Privacy Policy (https://policies.google.com/privacy).
-The uploaded reports are republished in full as part of a public dataset. Developers working on Go itself, both inside and outside Google, will use that dataset to better understand how the toolchain is being used and whether it is performing as expected.
+Once a week, the Go toolchain will randomly decide whether to upload that week's
+reports to a server at Google. The random choice is set so that a representative
+sample of systems upload reports each week. As more systems participate, each
+system uploads less often. This data is collected in accordance with the Google
+Privacy Policy (https://policies.google.com/privacy). The uploaded reports are
+republished in full as part of a public dataset. Developers working on Go
+itself, both inside and outside Google, will use that dataset to better
+understand how the toolchain is being used and whether it is performing as
+expected.
-You can collect telemetry information for local viewing without sending it to Google by using `go telemetry local`. If you later switch from `go telemetry local` to `go telemetry on`, the current week’s telemetry data may be uploaded. You may clear your local telemetry data by running `go telemetry clear` at any time.
+You can collect telemetry information for local viewing without sending it to
+Google by using `go telemetry local`. If you later switch from
+`go telemetry local` to `go telemetry on`, the current week’s telemetry data may
+be uploaded. You may clear your local telemetry data by running
+`go telemetry clear` at any time.
