README
¶
Go website
This repo holds content and serving programs for the golang.org and go.dev web sites.
Content is in _content/ (go.dev) and tour/ (tour.golang.org). Server code is in cmd/ and internal/.
To run the combined golang.org+go.dev 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.
JS/CSS Formatting
This repository uses prettier to format JS and CSS files.
See also:
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.
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 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.
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.
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.
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
_content
|
|
|
blog/appengine
This server can run on App Engine.
|
This server can run on App Engine. |
|
blog/h2push/server
The server command demonstrates a server with HTTP/2 Server Push support.
|
The server command demonstrates a server with HTTP/2 Server Push support. |
|
doc/codewalk
Generating random text: a Markov chain algorithm Based on the program presented in the "Design and Implementation" chapter of The Practice of Programming (Kernighan and Pike, Addison-Wesley 1999).
|
Generating random text: a Markov chain algorithm Based on the program presented in the "Design and Implementation" chapter of The Practice of Programming (Kernighan and Pike, Addison-Wesley 1999). |
|
doc/play
You can edit this code! Click here and start typing.
|
You can edit this code! Click here and start typing. |
|
talks/2014/go4java/runner
Package runner provides a Runner type that is used to define both RunCounter and EmbeddedRunCounter to show examples of how to use composition in Go.
|
Package runner provides a Runner type that is used to define both RunCounter and EmbeddedRunCounter to show examples of how to use composition in Go. |
|
blog
module
|
|
|
cmd
|
|
|
admingolangorg
The admingolangorg command serves an administrative interface for owners of the golang-org Google Cloud project.
|
The admingolangorg command serves an administrative interface for owners of the golang-org Google Cloud project. |
|
golangorg
Golangorg serves the golang.org web sites.
|
Golangorg serves the golang.org web sites. |
|
googlegolangorg
A trivial redirector for google.golang.org.
|
A trivial redirector for google.golang.org. |
|
versionprune
Binary versionprune prunes stale AppEngine versions for a specified service.
|
Binary versionprune prunes stale AppEngine versions for a specified service. |
|
go.dev
module
|
|
|
internal
|
|
|
backport/fmtsort
Package fmtsort provides a general stable ordering mechanism for maps, on behalf of the fmt and text/template packages.
|
Package fmtsort provides a general stable ordering mechanism for maps, on behalf of the fmt and text/template packages. |
|
backport/html/template
Package template (html/template) implements data-driven templates for generating HTML output safe against code injection.
|
Package template (html/template) implements data-driven templates for generating HTML output safe against code injection. |
|
backport/text/template
Package template implements data-driven templates for generating textual output.
|
Package template implements data-driven templates for generating textual output. |
|
backport/text/template/parse
Package parse builds parse trees for templates as defined by text/template and html/template.
|
Package parse builds parse trees for templates as defined by text/template and html/template. |
|
blog/atom
Package atom defines XML data structures for an Atom feed.
|
Package atom defines XML data structures for an Atom feed. |
|
codewalk
Package codewalk implements support for codewalk documents.
|
Package codewalk implements support for codewalk documents. |
|
dl
Package dl implements a simple downloads frontend server.
|
Package dl implements a simple downloads frontend server. |
|
env
Package env provides environment information for the golangorg server running on golang.org.
|
Package env provides environment information for the golangorg server running on golang.org. |
|
gitfs
Package gitfs presents a file tree downloaded from a remote Git repo as an in-memory fs.FS.
|
Package gitfs presents a file tree downloaded from a remote Git repo as an in-memory fs.FS. |
|
history
Package history holds the Go project release history.
|
Package history holds the Go project release history. |
|
memcache
Package memcache provides a minimally compatible interface for google.golang.org/appengine/memcache and stores the data in Redis (e.g., via Cloud Memorystore).
|
Package memcache provides a minimally compatible interface for google.golang.org/appengine/memcache and stores the data in Redis (e.g., via Cloud Memorystore). |
|
pkgdoc
Package pkgdoc serves package documentation.
|
Package pkgdoc serves package documentation. |
|
proxy
Package proxy proxies requests to the playground's compile and share handlers.
|
Package proxy proxies requests to the playground's compile and share handlers. |
|
redirect
Package redirect provides hooks to register HTTP handlers that redirect old godoc paths to their new equivalents and assist in accessing the issue tracker, wiki, code review system, etc.
|
Package redirect provides hooks to register HTTP handlers that redirect old godoc paths to their new equivalents and assist in accessing the issue tracker, wiki, code review system, etc. |
|
short
Package short implements a simple URL shortener, serving shortened urls from /s/key.
|
Package short implements a simple URL shortener, serving shortened urls from /s/key. |
|
spec
Package spec implements hyperlinking of the Go language specification.
|
Package spec implements hyperlinking of the Go language specification. |
|
texthtml
Package texthtml formats text files to HTML.
|
Package texthtml formats text files to HTML. |
|
tmplfunc
Package tmplfunc provides an extension of Go templates in which templates can be invoked as if they were functions.
|
Package tmplfunc provides an extension of Go templates in which templates can be invoked as if they were functions. |
|
web
Package web implements a basic web site serving framework.
|
Package web implements a basic web site serving framework. |
|
webtest
Package webtest implements script-based testing for web servers.
|
Package webtest implements script-based testing for web servers. |