Google Git
Sign in
go / website / 3d551ff78027c097b5b845266b663158e518dc32
commit3d551ff78027c097b5b845266b663158e518dc32[log] [tgz]
authorDmitri Shuralyov <dmitshur@golang.org>Fri May 24 10:39:12 2024 -0400
committerGopher Robot <gobot@golang.org>Fri May 24 15:26:34 2024 +0000
treed245318116b15f307246b8b34a6fb48abefa0dd8
parente7879e0f78ec3dbf8b9f42f3381d2a34a77fb423 [diff]
_content/doc: add go1.23.md placeholder

Add this file now so we can use the https://tip.golang.org/doc/go1.23
both before and after the release note fragments are merged, meaning
we won't need to tell people to abruptly stop looking at /doc/next and
start looking at /doc/go1.23 sometime in the next few weeks.

The /doc/next page may still be useful in some contexts where a moving
target URL works better than a fixed one, so leave it behind for now.

For golang/go#65614.

Change-Id: Ib28608f56b2a88b44e554bf24c04873f3ed6961b
Reviewed-on: https://go-review.googlesource.com/c/website/+/588057
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Reviewed-by: Jonathan Amsterdam <jba@google.com>
Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
1 file changed
tree: d245318116b15f307246b8b34a6fb48abefa0dd8
  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.