commit | a26b85f08fe847e1a87e900f4ac2b8b77e50af3f | [log] [tgz] |
---|---|---|
author | Rob Pike <r@golang.org> | Tue Jan 25 10:56:02 2022 +1100 |
committer | DO NOT USE <iant@google.com> | Sun Jan 30 22:05:33 2022 +0000 |
tree | 39e796ecb9ae35402c0f36c5656cdfae3b915c87 | |
parent | 55fb4e21dc8bd7017b24befc445c773e241e9e32 [diff] |
content/doc: add an explanatory preamble to Effective Go Explain that Effective Go is not a living document. No changes other than one new paragraph in the introduction. Fixes golang/go#49937 Update golang/go#28782 Change-Id: I615e48df56313e3d91e8b88b139159f64900db7e Reviewed-on: https://go-review.googlesource.com/c/website/+/380634 Reviewed-by: DO NOT USE <iant@google.com> Trust: Michael Knyszek <mknyszek@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.