Google Git
Sign in
go / website / 278ac223d6a207f67e2eb11deb50dab8351a7eff
commit278ac223d6a207f67e2eb11deb50dab8351a7eff[log] [tgz]
authorFilippo Valsorda <filippo@golang.org>Thu Dec 12 17:12:39 2024 +0100
committerGopher Robot <gobot@golang.org>Thu Dec 12 08:55:42 2024 -0800
tree852ea159368c819123b6bbb56a2a5a3689f0a117
parentb7e178d319a1e042a897eebeaf549483517c6133 [diff]
_content/doc/go1.24: minor nits

For golang/go#68545

Change-Id: Ie32bb7d09038fb13f738f60d8be99aa6eed69d37
Reviewed-on: https://go-review.googlesource.com/c/website/+/635596
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Auto-Submit: Filippo Valsorda <filippo@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Sam Thanawalla <samthanawalla@google.com>
1 file changed
tree: 852ea159368c819123b6bbb56a2a5a3689f0a117
  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.