summaryrefslogtreecommitdiff
path: root/development.md
diff options
context:
space:
mode:
authorTim Hockin <thockin@google.com>2015-12-02 09:54:21 -0800
committerTim Hockin <thockin@google.com>2015-12-10 12:09:25 -0800
commit458e489bbdd5a92cf483836c722cfdfca497c0d5 (patch)
tree6b9974b0872226aaeaa425028f24c2d40b88ecc5 /development.md
parent9b60d8c88083958918bb92b6104b1fe8d4e9b9ec (diff)
Make go version requirements clearer
Diffstat (limited to 'development.md')
-rw-r--r--development.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/development.md b/development.md
index 09abe1e7..3b5443bc 100644
--- a/development.md
+++ b/development.md
@@ -33,15 +33,29 @@ Documentation for other releases can be found at
# Development Guide
-# Releases and Official Builds
+This document is intended to be the canonical source of truth for things like
+supported toolchain versions for building Kubernetes. If you find a
+requirement that this doc does not capture, please file a bug. If you find
+other docs with references to requirements that are not simply links to this
+doc, please file a bug.
+
+This document is intended to be relative to the branch in which it is found.
+It is guaranteed that requirements will change over time for the development
+branch, but release branches of Kubernetes should not change.
+
+## Releases and Official Builds
Official releases are built in Docker containers. Details are [here](http://releases.k8s.io/HEAD/build/README.md). You can do simple builds and development with just a local Docker installation. If want to build go locally outside of docker, please continue below.
## Go development environment
-Kubernetes is written in [Go](http://golang.org) programming language. If you haven't set up Go development environment, please follow [this instruction](http://golang.org/doc/code.html) to install go tool and set up GOPATH. Ensure your version of Go is at least 1.3.
+Kubernetes is written in the [Go](http://golang.org) programming language. If you haven't set up a Go development environment, please follow [these instructions](http://golang.org/doc/code.html) to install the go tools and set up a GOPATH.
+
+### Go versions
+
+Requires Go version 1.4.x or 1.5.x
-## Git Setup
+## Git setup
Below, we outline one of the more common git workflows that core developers use. Other git workflows are also valid.