Google Git
Sign in
go / website / 29629ecc7e3ee3c3f612760b7501a3c466aeca82
commit29629ecc7e3ee3c3f612760b7501a3c466aeca82[log] [tgz]
authorRobert Findley <rfindley@google.com>Wed Jan 24 14:28:00 2024 -0500
committerGopher Robot <gobot@golang.org>Mon Mar 11 17:35:49 2024 +0000
treedc7000fefbd16506838f2b98c6adaf4769938d1d
parente2bd64a578a0dafddd20e8b0e8922d694c4ba1cd [diff]
_content/doc: add documentation for Go telemetry

Add documentation for Go telemetry, aimed at Go users who want to
understand telemetry better. This article goes into some detail about
the telemetry data flow, but doesn't get into details about x/telemetry
APIs, as those are mostly interesting only for Go toolchain developers,
and therefore belong in x/telemetry documentation.

For golang/go#63883

Change-Id: Ie7e82960a2dbe5e0c0c81e46dc0b0c86174365fe
Reviewed-on: https://go-review.googlesource.com/c/website/+/558196
Reviewed-by: Alan Donovan <adonovan@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Russ Cox <rsc@golang.org>
Auto-Submit: Robert Findley <rfindley@google.com>
5 files changed
tree: dc7000fefbd16506838f2b98c6adaf4769938d1d
  1. _content/
  2. _later/
  3. cmd/
  4. internal/
  5. tour/
  6. .eslintrc.yaml
  7. .gitattributes
  8. .prettierrc.yaml
  9. .stylelintrc.yaml
  10. codereview.cfg
  11. content.go
  12. CONTRIBUTING.md
  13. go-app-deploy.sh
  14. go.mod
  15. go.sum
  16. jest-transform.cjs
  17. LICENSE
  18. npm
  19. npx
  20. package-lock.json
  21. package.json
  22. PATENTS
  23. README.md
  24. tsconfig.json
README.md

Go website

Go Reference

This repo holds content and serving programs for the go.dev and golang.org web sites.

Content is in _content/ (go.dev) and tour/ (go.dev/tour). Server code is in cmd/ and internal/.

To run the combined go.dev+golang.org server to preview local content changes, use:

go run ./cmd/golangorg

The supporting programs cmd/admingolangorg and cmd/googlegolangorg are the servers for admin.golang.org and google.golang.org. (They do not use the _content/ directories.)

Each command directory has its own README.md explaining deployment.

JS/TS/CSS Formatting

This repository uses eslint to format JS and TS files, and stylelint to format CSS files.

See also:

It is encouraged that all JS, 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. Create a .gitignore file at repo root
  3. Add .gitignore and node_modules to .gitignore
  4. Run ./npm install

Run ESlint

./npx eslint [options] [file] [dir]

Run Stylelint

./npx stylelint [input] [options]

TypeScript Support

TypeScript files served from _content are transformed into JavaScript. Reference .ts files in html templates as module code.

<script type="module" src="/ts/filename.ts">

Write unit tests for TypeScript code using the jest testing framework.

Run Jest

./npx jest [TestPathPattern]

Deploying

Each time a CL is reviewed and submitted, the code is deployed to App Engine. See cmd/golangorg/README.md for details.

Report Issues / Send Patches

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

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