diff --git a/README.md b/README.md index 5f7382c84..89ea92037 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [base]: docs/glossary.md#base [declarative configuration]: docs/glossary.md#declarative-application-management [demo]: demos/README.md +[demos]: demos/README.md [imageBase]: docs/base.jpg [imageOverlay]: docs/overlay.jpg [kustomization]: docs/glossary.md#kustomization @@ -13,12 +14,11 @@ [kubernetes style]: docs/glossary.md#kubernetes-style-object `kustomize` is a command line tool supporting -template-free customization of YAML (or JSON) -objects that conform to the [kubernetes style]. - -If your objects have a `kind` and a `metadata` field, -kustomize can patch them to help you manage -configuration sharing and re-use. +template-free customization of YAML (or JSON) objects +that conform to the [kubernetes style]. If your +objects have a `kind` and a `metadata` field, +`kustomize` can patch them to support configuration +sharing and re-use. For more details, try a [demo]. @@ -52,6 +52,7 @@ _development, staging and production_. #### 3) Run kustomize -Run kustomize on your overlay. The result +Run `kustomize` on your overlay. The result is printed to `stdout` as a set of complete resources, ready to be [applied] to a cluster. +See the [demos]. diff --git a/demos/README.md b/demos/README.md index 802192a7e..834abcc2f 100644 --- a/demos/README.md +++ b/demos/README.md @@ -1,6 +1,7 @@ # Demos -These demos are covered by presubmit tests. +These demos assume that `kustomize` is on your `$PATH`. +They are covered by pre-submit tests. * [hello world](helloWorld.md) - Deploy multiple (differently configured) instances of a simple Hello diff --git a/demos/tree1.png b/demos/tree1.png deleted file mode 100644 index a92235187..000000000 Binary files a/demos/tree1.png and /dev/null differ diff --git a/demos/tree2.png b/demos/tree2.png deleted file mode 100644 index 275dd899b..000000000 Binary files a/demos/tree2.png and /dev/null differ diff --git a/docs/glossary.md b/docs/glossary.md index 2e41e6f5f..1b25d14f7 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -10,6 +10,7 @@ [base]: #base [bases]: #base [bespoke]: #bespoke-configuration +[gitops]: #gitops [k8s]: #kubernetes [kubernetes]: #kubernetes [kustomize]: #kustomize