commit | de15dbe30dfb3bde6040b510e6c38068fa30167a | [log] [tgz] |
---|---|---|
author | Russ Cox <rsc@golang.org> | Wed Oct 12 13:56:34 2022 -0400 |
committer | Russ Cox <rsc@golang.org> | Wed Nov 02 14:30:32 2022 +0000 |
tree | 739f32e6bda810333cb0616aef5e59c19402e81f | |
parent | 3c8a10182fd793a73f9ae925229ab570abbdb0de [diff] |
_content/doc/comment: document form of directive comments Fixes golang/go#43776. Change-Id: I3e18dbe5dfb0bca96a16203efd4c2a92636cf412 Reviewed-on: https://go-review.googlesource.com/c/website/+/442516 Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Ian Lance Taylor <iant@google.com>
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.