README

Go website

Go Reference

This repo holds content and serving programs for the golang.org web site.

Content is in _content/. Server code is in cmd/ and internal/.

To run the 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/ directory.)

Each command directory has its own README.md explaining deployment.

JS/CSS Formatting

This repository uses prettier to format JS and CSS files.

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.

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.

Expand ▾ Collapse ▴

Directories

Path Synopsis
_content
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.
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
Godoc extracts and generates documentation for Go programs.
Godoc extracts and generates documentation for Go programs.
googlegolangorg
A trivial redirector for google.golang.org.
A trivial redirector for google.golang.org.
internal
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.
godoc/golangorgenv
Package golangorgenv provides environment information for programs running at golang.org and its subdomains.
Package golangorgenv provides environment information for programs running at golang.org and its subdomains.
history
Package history stores historical data for the Go project.
Package history stores historical data for the Go project.
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).
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.