Google Git
Sign in
go / website / 9faf03bf18ade6f2b994e4542cd7ad50492bf209
commit9faf03bf18ade6f2b994e4542cd7ad50492bf209[log] [tgz]
authorDmitri Shuralyov <dmitshur@golang.org>Fri May 13 21:47:14 2022 -0400
committerGopher Robot <gobot@golang.org>Mon May 16 15:10:09 2022 +0000
tree016cd9367f207d029202812583b406e99d1f539f
parent0b719dcd447b81bc354e21bf71fd9e5e4ee986b7 [diff]
cmd/admingolangorg: update deployment to Go 1.16

Include a placeholder and initial value to clarify key/target inputs,
update 'golang.org' to 'go.dev', and use embed for the HTML template.

Also rewrite .gcloudignore to more effectively include only the bare
minimum files, hopefully in a way that won't get outdated as quickly.

Change-Id: Ic7b39fb6d8e54f93e657aae20bc4fd51c75039f4
Reviewed-on: https://go-review.googlesource.com/c/website/+/406374
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Reviewed-by: Jamal Carvalho <jamal@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org>
5 files changed
tree: 016cd9367f207d029202812583b406e99d1f539f
  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.