Google Git
Sign in
go / telemetry / 50079b3109511aef8be443e8a9e0f462620884c7
commit50079b3109511aef8be443e8a9e0f462620884c7[log] [tgz]
authorRobert Findley <rfindley@google.com>Wed Oct 16 21:42:53 2024 -0400
committerGopher Robot <gobot@golang.org>Thu Oct 17 03:07:30 2024 +0000
tree2570f44c1113ad28f60014a4a36856d6e61e5825
parent5eebfecbdf1fc890af647650e580334ee63528b5 [diff]
internal/chartconfig: improve package documentation

The chartconfig package is referenced directly by go.dev/doc/telemetry,
yet lacked some precision, and had some stale or misleading information.
Do a pass cleaning this up.

Change-Id: I546682182348e4870eeaf2dc6edeabf8928c00ff
Reviewed-on: https://go-review.googlesource.com/c/telemetry/+/620695
Reviewed-by: Alan Donovan <adonovan@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Robert Findley <rfindley@google.com>
1 file changed
tree: 2570f44c1113ad28f60014a4a36856d6e61e5825
  1. cmd/
  2. config/
  3. counter/
  4. crashmonitor/
  5. godev/
  6. internal/
  7. .dockerignore
  8. .eslintrc.json
  9. .gitattributes
  10. .gitignore
  11. .prettierrc.json
  12. .stylelintrc.json
  13. CONTRIBUTING.md
  14. dir.go
  15. doc.go
  16. go.mod
  17. go.sum
  18. LICENSE
  19. mode.go
  20. npm
  21. npx
  22. package-lock.json
  23. package.json
  24. PATENTS
  25. README.md
  26. start.go
  27. start_posix.go
  28. start_test.go
  29. start_windows.go
  30. tsconfig.json
  31. types_alias.go
README.md

Go Telemetry

This repository holds the Go Telemetry server code and libraries, used for hosting telemetry.go.dev and instrumenting Go toolchain programs with opt-in telemetry.

Warning: this repository is intended for use only in tools maintained by the Go team, including tools in the Go distribution and auxiliary tools like gopls or govulncheck. There are no compatibility guarantees for any of the packages here: public APIs will change in breaking ways as the telemetry integration is refined.

Notable Packages

Contributing

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.

The main issue tracker for the telemetry repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/telemetry:” in the subject line, so it is easy to find.

Linting & Formatting

This repository uses eslint to format TS files, stylelint to format CSS files, and prettier to format TS, CSS, Markdown, and YAML files.

See the style guides:

It is encouraged that all TS and CSS code be run through formatters before submitting a change. However, it is not a strict requirement enforced by CI.

Installing npm Dependencies:

  1. Install docker
  2. Run ./npm install

Run ESLint, Stylelint, & Prettier

./npm run all