Google Git
Sign in
go / website / cb81144c0c14223ac4c43af00d49ac81bd83f929
commitcb81144c0c14223ac4c43af00d49ac81bd83f929[log] [tgz]
authorDmitri Shuralyov <dmitshur@golang.org>Mon Apr 04 16:08:49 2022 -0400
committerDmitri Shuralyov <dmitshur@google.com>Mon Apr 04 21:12:26 2022 +0000
treef5b287ee1db9f3a430cce1492c2f1c8f2af40fe4
parentc7fff86154b2c9a90e610e5772aa24230c8f95ab [diff]
internal/history: document future Go 1.18.1 and 1.17.9 releases

These releases have been pre-announced to include a PRIVATE security fix:
https://groups.google.com/g/golang-announce/c/vtbMjE04kPk/m/xE-FGxCXCAAJ.

The fix summary is intentionally left blank until the day of the release,
other than to mention that the issue affects the standard library as the
Go security policy permits disclosing.

In the future, the go.dev website can be improved to display this
information automatically so that it doesn't involve a manual CL.
The motivation for this change was to investigate that the recent
FixSummary type and template are flexible enough to support that.

Change-Id: I340e3b44440cecdb9b25c426f97cd8ff31c60acd
Reviewed-on: https://go-review.googlesource.com/c/website/+/398214
Trust: Dmitri Shuralyov <dmitshur@google.com>
Run-TryBot: Dmitri Shuralyov <dmitshur@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Julie Qiu <julieqiu@google.com>
1 file changed
tree: f5b287ee1db9f3a430cce1492c2f1c8f2af40fe4
  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.