| commit | 89cd6982bcf07fd92de22f056a02c4c771b36b80 | [log] [tgz] |
|---|---|---|
| author | Dmitri Shuralyov <dmitshur@golang.org> | Wed May 08 16:09:16 2024 -0400 |
| committer | Gopher Robot <gobot@golang.org> | Wed May 22 18:44:50 2024 +0000 |
| tree | 7ac3f1405b0fce4bb0e6af14311b0e2220b6cbcf | |
| parent | 9e5eadff51ec762231f3d2ba6aa8be30535224c4 [diff] |
cmd/golangorg: add doc/next page to preview draft release notes The improved release note process is being used starting with Go 1.23. That means instead of a single doc/go1.23.html draft file in the main Go repository, doc/next contains a set of release note fragments. Having small, orthogonal files avoids merge conflicts, and a release note test requires that release notes are written and included in the same CL that's adding new APIs. As a result, the set of completed release notes even before we enter the release freeze is greater than ever before. While it's possible to view those fragments using tip.golang.org (e.g., by visiting https://tip.golang.org/doc/next), reading them that way isn't practical. The relnote generate tool exists to merge fragments into a complete Markdown document, and this tool will be used when eventually moving a complete draft of Go 1.23 release notes to x/website. To aid the remaining work of completing the release note draft, this change adds a dynamic /doc/next page to preview what the relnote generate tool will produce. Combined with existing functionality of the -tip flag, it makes https://tip.golang.org/doc/next display a live preview of the checked-in release notes draft. It can also be used to preview release note draft locally. For example, if $HOME/gotip is a Go checkout where one is editing doc/next content: go run golang.org/x/website/cmd/golangorg@latest -goroot=$HOME/gotip Will serve a live preview at http://localhost:6060/go.dev/doc/next. It can be slightly more convenient to refresh a browser without having to re-run 'relnote generate'. For golang/go#64169. For golang/go#65614. Change-Id: Ie1d3650076421a95a691dd84a554a113dd1187b1 Reviewed-on: https://go-review.googlesource.com/c/website/+/587436 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Jonathan Amsterdam <jba@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.