Google Git
Sign in
go / website / ed4f083ea4ff83f7a083042031cdd8dd679bdac2
commited4f083ea4ff83f7a083042031cdd8dd679bdac2[log] [tgz]
authorZvonimir Pavlinovic <zpavlinovic@google.com>Wed Sep 18 18:38:21 2024 +0000
committerZvonimir Pavlinovic <zpavlinovic@google.com>Wed Sep 18 19:28:47 2024 +0000
tree52205e6b8b1ea6e7ad23f7b04afee7fb31a0acff
parente588f826099576f1f00525da64e11517aba3cd84 [diff]
_content/doc/tutorial: improve documentation on installing govulncheck

govulncheck's go.mod now requires the use of Go version that is at least
one less than the current latest Go release. Remove the old restriction
as that is now incorrect and confusing. Just tell people to use the
latest Go version.

Updates golang/go#68034

Change-Id: I97a59d4764592496918b44c10345a2fadb92aac8
Reviewed-on: https://go-review.googlesource.com/c/website/+/614235
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Ian Cottrell <iancottrell@google.com>
2 files changed
tree: 52205e6b8b1ea6e7ad23f7b04afee7fb31a0acff
  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.