summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQuinton Hoole <quinton@google.com>2015-03-04 17:03:55 -0800
committerQuinton Hoole <quinton@google.com>2015-03-04 17:18:05 -0800
commit9f5ea46527fa41d04ef4226931730e4c61b6bf22 (patch)
tree66532ac47f58991d763c3948b94a287b1d3cf907
parent404a276a80f0e49c9dec5fb9c83d3d1cc0e782a1 (diff)
Add documentation about the Kubernetes Github Flow.
Added an animation (and a link to it) detailing the standard Kubernetes Github Flow.
-rw-r--r--development.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/development.md b/development.md
index 615b4d55..a20834e9 100644
--- a/development.md
+++ b/development.md
@@ -8,7 +8,7 @@ Official releases are built in Docker containers. Details are [here](../../buil
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.
-## Put kubernetes into GOPATH
+## Clone kubernetes into GOPATH
We highly recommend to put kubernetes' code into your GOPATH. For example, the following commands will download kubernetes' code under the current user's GOPATH (Assuming there's only one directory in GOPATH.):
@@ -22,7 +22,9 @@ $ git clone https://github.com/GoogleCloudPlatform/kubernetes.git
The commands above will not work if there are more than one directory in ``$GOPATH``.
-(Obviously, clone your own fork of Kubernetes if you plan to do development.)
+If you plan to do development, read about the
+[Kubernetes Github Flow](https://docs.google.com/a/google.com/presentation/d/1WDGN_ggq1Ae3eeQmbSCMyUG1UhhRH6UZTy0pePq09Xo/pub?start=false&loop=false&delayms=3000),
+and then clone your own fork of Kubernetes as described there.
## godep and dependency management