Google Git
Sign in
go / website / a3584794592562e4699d6ed35299e4a0346b7e5c
commita3584794592562e4699d6ed35299e4a0346b7e5c[log] [tgz]
authorRobert Findley <rfindley@google.com>Wed May 03 18:45:59 2023 -0400
committerRobert Findley <rfindley@google.com>Thu May 04 14:33:33 2023 +0000
treeda00c3394e75a3ae181db9036ae3be52abefc38a
parent0a584939d7db94b21b82804216a749b6a53c4949 [diff]
_content: fix package name in branch module image

The v2 branch should use the name "package1" for its example package, to
be consistent with the v1 branch and the subsequent documentation.

I edited the image in GIMP and exported with maximal compression, then
used optipng to optimize the resulting file, but still did not quite
achieve the previous level of compression.

Fixes golang/go#59948

Change-Id: I64d9d4d21e5bf79731cdd02401420bd81e2bb33d
Reviewed-on: https://go-review.googlesource.com/c/website/+/492475
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Robert Findley <rfindley@google.com>
Reviewed-by: Jamal Carvalho <jamal@golang.org>
1 file changed
tree: da00c3394e75a3ae181db9036ae3be52abefc38a
  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.