|author||Russ Cox <email@example.com>||Sat Jun 04 10:44:43 2022 -0400|
|committer||Russ Cox <firstname.lastname@example.org>||Tue Jun 07 16:23:46 2022 +0000|
_content/doc: document doc comments at go.dev/doc/comment This new page documents how to write doc comments, which has always been missing, as well as explaining the new Go 1.19 doc comment syntax and what to do if gofmt reformats a comment in an unexpected way. For golang/go#51082. Fixes golang/go#44194. Change-Id: I64baed6124e05cbe084c2df14f2a5611c6fccd5d Reviewed-on: https://go-review.googlesource.com/c/website/+/410394 Run-TryBot: Russ Cox <email@example.com> Reviewed-by: Dmitri Shuralyov <firstname.lastname@example.org> Reviewed-by: Chris Hines <email@example.com> TryBot-Result: Gopher Robot <firstname.lastname@example.org> Reviewed-by: Michael Stapelberg <email@example.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.
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.
./npx eslint [options] [file] [dir]
./npx stylelint [input] [options]
<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.