Google Git
Sign in
go/website/1aad670007bd8844a4bb16974f6f3ef6b134a4a7
commit
1aad670007bd8844a4bb16974f6f3ef6b134a4a7
[log]
author
Alan Donovan <adonovan@google.com>
Wed Jul 02 16:14:14 2025 -0400
committer
Alan Donovan <adonovan@google.com>
Tue Jul 08 15:46:03 2025 -0700
tree
000eab46cb5c80a8d2c1e6be86dd2bb9a764e5a2
parent
1a9dcf1e34926a03e150cd0839586ec9a2de0f11 [diff]
cmd/golangorg: serve gopls docs at go.dev/gopls

The go.dev/gopls endpoint serves the gopls/doc
directory at the latest release of gopls;
the tip.golang.dev/gopls endpoint serves the latest
x/tools commit.

The GOLANGORG_LOCAL_X_TOOLS environment variable specifies
a local directory, overriding the use of git,
for previewing local doc changes.

Also, a command to recursively check links within the
go.dev/gopls subtree.

Fixes golang/go#68977

Change-Id: I5d92e6f0e5fdbed721a57f0a1ace2ac98e562fc8
Reviewed-on: https://go-review.googlesource.com/c/website/+/685635
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
9 files changed
tree: 000eab46cb5c80a8d2c1e6be86dd2bb9a764e5a2
  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 git repository is https://go.googlesource.com/website.

The main issue tracker for the website repository is located at https://go.dev/issues. Prefix your issue with “x/website:” in the subject line, so it is easy to find.