From 17cf5a7506f5d511b70ff8ad8eab240048c41e8f Mon Sep 17 00:00:00 2001 From: Benjamin Elder Date: Mon, 5 Aug 2019 12:49:23 -0700 Subject: [PATCH] clarify go support, call out strongly to the docs site --- README.md | 5 +++-- site/content/_index.md | 3 ++- site/content/docs/user/quick-start.md | 4 +++- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3dda6268..5ebf337e 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ Build Status Go Report Card

-### [View The Documentation](https://kind.sigs.k8s.io) +# Please see [Our Documentation](https://kind.sigs.k8s.io/docs/user/quick-start/) for more in-depth installation etc. kind is a tool for running local Kubernetes clusters using Docker container "nodes". kind is primarily designed for testing Kubernetes 1.11+, initially targeting the [conformance tests]. -If you have [go] and [docker] installed `GO111MODULE="on" go get sigs.k8s.io/kind@v0.4.0 && kind create cluster` is all you need! +If you have [go] ([1.11+][go-supported]) and [docker] installed `GO111MODULE="on" go get sigs.k8s.io/kind@v0.4.0 && kind create cluster` is all you need! 2x speed `kind create cluster` demo @@ -102,6 +102,7 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of [go]: https://golang.org/ +[go-supported]: https://golang.org/doc/devel/release.html#policy [docker]: https://www.docker.com/ [community page]: http://kubernetes.io/community/ [Kubernetes Code of Conduct]: code-of-conduct.md diff --git a/site/content/_index.md b/site/content/_index.md index 432a4f82..5ae09c67 100644 --- a/site/content/_index.md +++ b/site/content/_index.md @@ -3,7 +3,7 @@ [kind] is a tool for running local Kubernetes clusters using Docker container "nodes". kind is primarily designed for testing Kubernetes 1.11+, initially targeting the [conformance tests]. -If you have [go] and [docker] installed `GO111MODULE="on" go get sigs.k8s.io/kind@v0.4.0 && kind create cluster` is all you need! +If you have [go] ([1.11+][go-supported]) and [docker] installed `GO111MODULE="on" go get sigs.k8s.io/kind@v0.4.0 && kind create cluster` is all you need! 2x speed `kind create cluster` demo @@ -84,6 +84,7 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of [kind]: https://sigs.k8s.io/kind [go]: https://golang.org/ +[go-supported]: https://golang.org/doc/devel/release.html#policy [docker]: https://www.docker.com/ [community page]: http://kubernetes.io/community/ [Kubernetes Code of Conduct]: code-of-conduct.md diff --git a/site/content/docs/user/quick-start.md b/site/content/docs/user/quick-start.md index fcb70ee7..7ab6749c 100644 --- a/site/content/docs/user/quick-start.md +++ b/site/content/docs/user/quick-start.md @@ -17,7 +17,8 @@ This guide covers getting started with the `kind` command. You can either install kind with `GO111MODULE="on" go get sigs.k8s.io/kind@v0.4.0` or clone this repo and run `make build` from the repository. -**NOTE**: please use the latest go to do this, ideally go 1.12.7 or greater. +**NOTE**: please use the latest Go to do this, ideally go 1.12.7 or greater. +A version of Go officially [supported upstream][go-supported] by the Go project must be used. This will put `kind` in `$(go env GOPATH)/bin`. You may need to add that directory to your `$PATH` as shown [here](https://golang.org/doc/code.html#GOPATH) if you encounter the error @@ -388,6 +389,7 @@ The structure of the logs will look more or less like this: The logs contain information about the Docker host, the containers running kind, the Kubernetes cluster itself, etc. +[go-supported]: https://golang.org/doc/devel/release.html#policy [known issues]: /docs/user/known-issues [node image]: /docs/design/node-image [base image]: /docs/design/base-image