Google Git
Sign in
go / website / 37dcb7bd3bb5b44d79a11d39df1e415a26b26604
commit37dcb7bd3bb5b44d79a11d39df1e415a26b26604[log] [tgz]
authorAlberto Donizetti <alb.donizetti@gmail.com>Fri Mar 18 10:49:14 2022 +0100
committerIan Lance Taylor <iant@google.com>Thu Mar 24 20:10:01 2022 +0000
tree9ee6c5d0bd0929c2afebf64cc8e6ae09b941a008
parent07c93911183265c8ace2c082a91160be850f7304 [diff]
_content/doc: emphasize need to remove existing installations

This change updates the Linux installation instructions to emphasize
the need to delete an existing Go tree in /usr/local/go before
untarring the downloaded archive.

This is a common mistake people seem to make on Linux, and it's known
to produce broken Go installations.

Updates golang/go#51760

Change-Id: Ia7375957a6034defc708add74cf3c2cf4dbee5d4
Reviewed-on: https://go-review.googlesource.com/c/website/+/393755
Run-TryBot: Alberto Donizetti <alb.donizetti@gmail.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Jamal Carvalho <jamalcarvalho@google.com>
Trust: Ian Lance Taylor <iant@google.com>
1 file changed
tree: 9ee6c5d0bd0929c2afebf64cc8e6ae09b941a008
  1. _content/
  2. _later/
  3. cmd/
  4. internal/
  5. tour/
  6. .eslintrc.yaml
  7. .gitattributes
  8. .prettierrc.yaml
  9. .stylelintrc.yaml
  10. AUTHORS
  11. codereview.cfg
  12. content.go
  13. CONTRIBUTING.md
  14. CONTRIBUTORS
  15. go-app-deploy.sh
  16. go.mod
  17. go.sum
  18. jest-transform.cjs
  19. LICENSE
  20. npm
  21. npx
  22. package-lock.json
  23. package.json
  24. PATENTS
  25. README.md
  26. 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.