Google Git
Sign in
go / website / fd9b92be517263cf657d15f691d0879127877c1e
commitfd9b92be517263cf657d15f691d0879127877c1e[log] [tgz]
authorJulian Beltz <MJayBeltz@gmail.com>Thu Aug 08 14:10:35 2024 +0000
committerGopher Robot <gobot@golang.org>Mon Mar 03 08:45:36 2025 -0800
tree0e3f20678f4e461ae1873fe8335312ef1fdcdd2e
parent8b2902f950802f3da01f9eb53daaf15de7639fc0 [diff]
_content/doc/tutorial: apply the "keep going" principle to "add a test" examples

Fixes golang/go#68741

Change-Id: I287c99df7447a4894d3b9c65fa1ae0932858d32e
GitHub-Last-Rev: ec26e446b9609e6cc7f29663ae670a235980ed14
GitHub-Pull-Request: golang/website#297
Reviewed-on: https://go-review.googlesource.com/c/website/+/603335
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
Auto-Submit: Sean Liao <sean@liao.dev>
Reviewed-by: Robert Findley <rfindley@google.com>
Commit-Queue: Sean Liao <sean@liao.dev>
Auto-Submit: Robert Findley <rfindley@google.com>
Reviewed-by: Sean Liao <sean@liao.dev>
1 file changed
tree: 0e3f20678f4e461ae1873fe8335312ef1fdcdd2e
  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.