Google Git
Sign in
go / website / b2020690573d42ad59cf673388a1453ea3a966c4
commitb2020690573d42ad59cf673388a1453ea3a966c4[log] [tgz]
authorEli Bendersky <eliben@golang.org>Fri May 19 12:42:33 2023 -0700
committerEli Bendersky‎ <eliben@golang.org>Fri May 19 20:51:49 2023 +0000
treeb48cee7f80b0a15cbb364032e980cfaf21a91f60
parentb3eae53547fab34a8b51e5553ca1c7ea59d0f3d5 [diff]
_content/doc: fixes to the table of contents

Move FAQ from the Modules section (where it doesn't belong), and remove
a stale header since a whole section exists about DB access.

Change-Id: If40e1ba2e606b4b2a4135aea5904a803b674b5b4
Reviewed-on: https://go-review.googlesource.com/c/website/+/496555
Run-TryBot: Eli Bendersky‎ <eliben@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Cameron Balahan <cbalahan@google.com>
Reviewed-by: Todd Kulesza <tkulesza@google.com>
1 file changed
tree: b48cee7f80b0a15cbb364032e980cfaf21a91f60
  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. 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.