From cf5d51260eee050d200602c570a3467d7e4c0398 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marko=20Luk=C5=A1a?= Date: Fri, 23 Aug 2019 12:14:04 +0200 Subject: [PATCH 1/3] Update README.md to make kind commands stand out By putting the commands for running/stopping kind into a separate line, it makes it easier for people who are just skimming the readme to quickly find them. --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d7c5d40c..bea75a1d 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,24 @@ mv ./kind /some-dir-in-your-PATH/kind ``` To use kind, you will need to [install docker]. -Once you have docker running you can create a cluster with `kind create cluster` -To delete your cluster use `kind delete cluster` +Once you have docker running you can create a cluster with + +```console +kind create cluster +``` + +To delete your cluster use +```console +kind delete cluster +``` To create a cluster from Kubernetes source: - ensure that Kubernetes is cloned in `$(go env GOPATH)/src/k8s.io/kubernetes` -- build a node image and create a cluster with `kind build node-image && kind create cluster --image kindest/node:latest` +- build a node image and create a cluster with +```console +kind build node-image && kind create cluster --image kindest/node:latest +``` Multi-node clusters and other advanced features may be configured with a config file, for more usage see [the docs][user guide] or run `kind [command] --help` From 4f2e8503eaa1e97040b9b26c2d915c5a9a0077d0 Mon Sep 17 00:00:00 2001 From: Benjamin Elder Date: Fri, 1 Nov 2019 07:13:39 -0700 Subject: [PATCH 2/3] split commands one to a line in code blocks --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bea75a1d..a8dfbf32 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,8 @@ To create a cluster from Kubernetes source: - ensure that Kubernetes is cloned in `$(go env GOPATH)/src/k8s.io/kubernetes` - build a node image and create a cluster with ```console -kind build node-image && kind create cluster --image kindest/node:latest +kind build node-image +kind create cluster --image kindest/node:latest ``` Multi-node clusters and other advanced features may be configured with a config From 3ac87cd498896fc1f5402a935310b74796f366d4 Mon Sep 17 00:00:00 2001 From: Benjamin Elder Date: Fri, 1 Nov 2019 07:17:18 -0700 Subject: [PATCH 3/3] normalize site index and README --- README.md | 7 ++++--- site/content/_index.md | 20 +++++++++++++++++--- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a8dfbf32..4a3233ba 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,14 @@ mv ./kind /some-dir-in-your-PATH/kind ``` To use kind, you will need to [install docker]. -Once you have docker running you can create a cluster with +Once you have docker running you can create a cluster with: ```console kind create cluster ``` -To delete your cluster use +To delete your cluster use: + ```console kind delete cluster ``` @@ -62,7 +63,7 @@ kind delete cluster To create a cluster from Kubernetes source: - ensure that Kubernetes is cloned in `$(go env GOPATH)/src/k8s.io/kubernetes` -- build a node image and create a cluster with +- build a node image and create a cluster with: ```console kind build node-image kind create cluster --image kindest/node:latest diff --git a/site/content/_index.md b/site/content/_index.md index d21f0a57..921e9bb8 100644 --- a/site/content/_index.md +++ b/site/content/_index.md @@ -28,14 +28,28 @@ shown [here](https://golang.org/doc/code.html#GOPATH) if you encounter the error `kind: command not found` after installation. To use kind, you will also need to [install docker]. -Once you have docker running you can create a cluster with `kind create cluster` -To delete your cluster use `kind delete cluster` +Once you have docker running you can create a cluster with: + +``` +kind create cluster +``` + +To delete your cluster use: + +``` +kind delete cluster +``` To create a cluster from Kubernetes source: - ensure that Kubernetes is cloned in `$(go env GOPATH)/src/k8s.io/kubernetes` -- build a node image and create a cluster with `kind build node-image && kind create cluster --image kindest/node:latest` +- build a node image and create a cluster with + +``` +kind build node-image +kind create cluster --image kindest/node:latest +``` Multi-node clusters and other advanced features may be configured with a config file, for more usage see [the user guide][user guide] or run `kind [command] --help`