Google Git
Sign in
go/website/500af5d47138a5dca0f321966b9e8e244736e0cc
commit
500af5d47138a5dca0f321966b9e8e244736e0cc
[log]
author
Austin Clements <austin@google.com>
Fri Dec 27 13:51:49 2024 -0500
committer
Gopher Robot <gobot@golang.org>
Thu Jan 02 10:55:47 2025 -0800
tree
31fa5d158e70b7c19326add63b7655dfb5b2cb18
parent
5e6fc827edf87a3ec92dbf1bf46df8b30064938d [diff]
_content/doc/go1.24: link to in-tree GOCACHEPROG docs

Currently the release notes link to the proposal for GOCACHEPROG,
which isn't ideal and is also slightly outdated. CL 638995 moves the
protocol documentation to its own package that we can link to and that
can't get out of date, so point the release notes at this
documentation.

For golang/go#71032

Change-Id: I8d4db0a0153333b40f9021f030a36184546bfe51
Reviewed-on: https://go-review.googlesource.com/c/website/+/638378
Auto-Submit: Austin Clements <austin@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
1 file changed
tree: 31fa5d158e70b7c19326add63b7655dfb5b2cb18
  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 git repository is https://go.googlesource.com/website.

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