2020-08-27 23:34:57 +03:00
# Go website
2019-01-04 17:06:45 +03:00
2020-12-04 01:43:40 +03:00
[![Go Reference ](https://pkg.go.dev/badge/golang.org/x/website.svg )](https://pkg.go.dev/golang.org/x/website)
2021-08-03 07:54:24 +03:00
This repo holds content and serving programs for the golang.org and go.dev web sites.
2019-01-04 17:06:45 +03:00
2021-11-18 06:51:08 +03:00
Content is in _content/ (go.dev) and tour/ (tour.golang.org).
2021-08-03 07:54:24 +03:00
Server code is in cmd/ and internal/.
2019-01-04 17:06:45 +03:00
2021-08-03 07:54:24 +03:00
To run the combined golang.org+go.dev server to preview local content changes, use:
2020-08-27 23:34:57 +03:00
2021-02-17 05:26:23 +03:00
go run ./cmd/golangorg
2020-08-27 23:34:57 +03:00
2021-02-12 22:32:52 +03:00
The supporting programs cmd/admingolangorg and cmd/googlegolangorg
are the servers for admin.golang.org and google.golang.org.
2021-08-03 07:54:24 +03:00
(They do not use the _content/ directories.)
2020-08-27 23:34:57 +03:00
2021-02-12 22:32:52 +03:00
Each command directory has its own README.md explaining deployment.
2019-01-04 17:06:45 +03:00
2019-06-26 12:03:53 +03:00
## JS/CSS Formatting
This repository uses [prettier ](https://prettier.io/ ) to format JS and CSS files.
2021-11-18 06:51:08 +03:00
See also:
- [CSS ](https://golang.org/wiki/CSSStyleGuide )
- [JavaScript ](https://google.github.io/styleguide/jsguide.html )
2019-06-26 12:03:53 +03:00
The version of `prettier` used is 1.18.2.
It is encouraged that all JS and CSS code be run through this before submitting
a change. However, it is not a strict requirement enforced by CI.
2021-11-18 06:51:08 +03:00
## Deploying
Each time a CL is reviewed and submitted, the blog is automatically deployed to App Engine.
If the CL is submitted with a Website-Publish +1 vote,
the new deployment automatically becomes https://go.dev/.
Otherwise, the new deployment can be found in the
[App Engine versions list ](https://console.cloud.google.com/appengine/versions?project=golang-org&serviceId=default ) and verified and manually promoted.
If the automatic deployment is not working, or to check on the status of a pending deployment,
see the “website-redeploy-go-dev” trigger in the
[Cloud Build console ](https://console.cloud.google.com/cloud-build/builds?project=golang-org ).
2019-01-04 17:06:45 +03:00
## Report Issues / Send Patches
This repository uses Gerrit for code changes. To learn how to submit changes to
this repository, see https://golang.org/doc/contribute.html.
2019-02-27 03:15:19 +03:00
The main issue tracker for the website repository is located at
2019-01-04 17:06:45 +03:00
https://github.com/golang/go/issues. Prefix your issue with "x/website:" in the
subject line, so it is easy to find.
2021-02-12 22:32:52 +03:00