Google Git
Sign in
go / website / 2c92ff85656e055c20cfca3a292f104f926022a1
commit2c92ff85656e055c20cfca3a292f104f926022a1[log] [tgz]
authorMatt T. Proud <matt.proud@gmail.com>Sat Sep 28 13:29:18 2024 +0000
committerGopher Robot <gobot@golang.org>Tue Oct 01 18:17:25 2024 +0000
tree6025658216cd372b60178f1f20384e3d9d7d36ec
parentfa72e5e7779d181ec458881b818b707d32659850 [diff]
_content/blog: cross-reference context articles

This change cross-references the context.md and context-and-structs.md
articles with each other with the addition of the conventional
"Further reading" sections. The context-and-structs.md article has
been somewhat of a singleton article without being referenced from the
other one, and it would be worth providing a hair more exposure given
the subtleties of the API.

Change-Id: Ifadcf6ec3f9cc47fff1e63f6841b7705fd018a4f
GitHub-Last-Rev: 73612713d5b6acbfb699b0f02bd634c32108b0f4
GitHub-Pull-Request: golang/website#299
Reviewed-on: https://go-review.googlesource.com/c/website/+/616495
Reviewed-by: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
2 files changed
tree: 6025658216cd372b60178f1f20384e3d9d7d36ec
  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 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.