commit | ca1fc50a3bcb2e30da453bcc132e9aed9387a3b1 | [log] [tgz] |
---|---|---|
author | Matthew Dempsky <mdempsky@google.com> | Thu Aug 31 19:48:55 2023 -0700 |
committer | Matthew Dempsky <mdempsky@google.com> | Fri Sep 01 07:02:54 2023 +0000 |
tree | effd59a45a0dff7e1a18ecd1576014d8a6aac5d6 | |
parent | 2bbd800a01aeb03d937def7e3722b8a47ef9b06c [diff] |
_content/doc/comment: mention "reports whether" idiom Mention the idiom of using "reports whether" to describe functions that return a boolean. While here, replace several uses of "func" with "function". In the Go spec, "func" is a keyword used in function declarations and function literals, but the declared object is always referred to as a "function". Also, change "arguments" to "parameters". Again, in the Go spec, "arguments" is used to describe the operands that appear in a call expression, whereas "parameters" are the objects declared in a function signature. Change-Id: I01dfafd05af1852a8d2056bdabbda1e2bcc8cbb7 Reviewed-on: https://go-review.googlesource.com/c/website/+/524956 Reviewed-by: Rob Pike <r@golang.org> Reviewed-by: Ian Lance Taylor <iant@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.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.