Google Git
Sign in
go / website / 97c56edbf39ac4976aad3862fbd48c2aaa989a9a
commit97c56edbf39ac4976aad3862fbd48c2aaa989a9a[log] [tgz]
authorOleksandr Redko <oleksandr.red+github@gmail.com>Tue Jun 25 17:41:30 2024 +0300
committerGopher Robot <gobot@golang.org>Mon Jul 01 13:45:53 2024 +0000
tree0c6985f8436c666a6db5be0732abc11a0689d736
parent43d14f6c806d303c6cbfd8d58b438d2db0de1ec1 [diff]
_content/tour: change '// +build' to '//go:build'

Rename no-build to nobuild, no-run to norun because it's forbidden
to use hyphen in a build constraint name.

Change-Id: Ide0cd3c72f6c79c640b601c0526e08223de04610
Reviewed-on: https://go-review.googlesource.com/c/website/+/594815
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Than McIntosh <thanm@google.com>
Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org>
107 files changed
tree: 0c6985f8436c666a6db5be0732abc11a0689d736
  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. content_test.go
  13. CONTRIBUTING.md
  14. go-app-deploy.sh
  15. go.mod
  16. go.sum
  17. jest-transform.cjs
  18. LICENSE
  19. npm
  20. npx
  21. package-lock.json
  22. package.json
  23. PATENTS
  24. README.md
  25. 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.