Google Git
Sign in
go / website / 4e362b43a725215ddc7e8f1a969c51ed0e4325d6
commit4e362b43a725215ddc7e8f1a969c51ed0e4325d6[log] [tgz]
authorRobert Findley <rfindley@google.com>Wed Oct 16 22:22:02 2024 -0400
committerGopher Robot <gobot@golang.org>Thu Oct 17 03:07:35 2024 +0000
tree69e5e978b175cc8229021c3ff84c73e0cf57b5b2
parentaaca907f494912f0eda554bdfc2c9cbe97458061 [diff]
_content/doc/telemetry.md: update documentation on the proposal process

The documentation of the telemetry proposal process at
go.dev/doc/telemetry was stale, and didn't reflect the new, lighter
weight issue template. Fix this, and tone down some of the lofty prose,
adding more discussion of the motivations behind the process.

Also move the proposal process to its own section, to avoid burying it
under the 'Uploading and Reporting' section, and to emphasize that it
relates to charting as well.

Change-Id: I95b6ca7008a0dfff9862bb50dc30b25217726de5
Reviewed-on: https://go-review.googlesource.com/c/website/+/620715
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Robert Findley <rfindley@google.com>
Reviewed-by: Alan Donovan <adonovan@google.com>
1 file changed
tree: 69e5e978b175cc8229021c3ff84c73e0cf57b5b2
  1. _content/
  2. cmd/
  3. internal/
  4. tour/
  5. .eslintrc.yaml
  6. .gitattributes
  7. .prettierrc.yaml
  8. .stylelintrc.yaml
  9. codereview.cfg
  10. content.go
  11. content_test.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.