commit | ecd2fa3d3c8c32c635d71aa36fcb956d50270df6 | [log] [tgz] |
---|---|---|
author | Russ Cox <rsc@golang.org> | Mon Jun 27 18:17:21 2022 -0400 |
committer | Russ Cox <rsc@golang.org> | Tue Jun 28 13:01:52 2022 +0000 |
tree | 74fc36016778fde129f18ec0e4bc6f01051be6b3 | |
parent | b1d076a07297daf9298edce197474cb73fd71fcb [diff] |
_content/doc/comment: add note about conflicting package imports When multiple source files import different packages to the same name, that creates an ambiguity, disallowing the use of the short package name in doc comment links. For golang/go#51082. Change-Id: Id46ca1e2db2c681e02ed34fc4dd57e3e43030994 Reviewed-on: https://go-review.googlesource.com/c/website/+/414694 Reviewed-by: Ian Lance Taylor <iant@google.com> Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Gopher Robot <gobot@golang.org>
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.
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.
./npm install
./npx eslint [options] [file] [dir]
./npx stylelint [input] [options]
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.
./npx jest [TestPathPattern]
Each time a CL is reviewed and submitted, the code is deployed to App Engine. See cmd/golangorg/README.md for details.
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.