demos --> examples

examples/ is pretty standard whereas demos/ isn't. So I just refactored that.

Signed-off-by: Ahmet Alp Balkan <[email protected]>

Author: ahmetb

CONTRIBUTING.md

@@ -16,7 +16,7 @@
 1. Fork the repo, develop and test your code.
    See the [github workflow guide].
 1. For _new features_, provide a markdown-based demo following
-   the pattern established in the [demos](demos) directory.
+   the pattern established in the [examples](examples) directory.
    Run `bin/pre-commit.sh` to test your demo.
 1. Submit a pull request.
 

README.md

@@ -1,26 +1,3 @@
-[KEP]: https://github.com/kubernetes/community/blob/master/keps/sig-cli/0008-kustomize.md
-[`make`]: https://www.gnu.org/software/make
-[`sed`]: https://www.gnu.org/software/sed
-[applied]: docs/glossary.md#apply
-[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
-[install]: INSTALL.md
-[kubernetes style]: docs/glossary.md#kubernetes-style-object
-[kustomization]: docs/glossary.md#kustomization
-[overlay]: docs/glossary.md#overlay
-[overlays]: docs/glossary.md#overlay
-[release page]: https://github.com/kubernetes-sigs/kustomize/releases
-[resource]: docs/glossary.md#resource
-[resources]: docs/glossary.md#resource
-[sig-cli]: https://github.com/kubernetes/community/blob/master/sig-cli/README.md
-[variant]: docs/glossary.md#variant
-[variants]: docs/glossary.md#variant
-[workflows]: docs/workflows.md
-
 # kustomize
 
 `kustomize` lets you customize raw, template-free YAML
@@ -37,7 +14,7 @@ and it's like [`sed`], in that it emits editted text.
 
 **Installation**: Download a binary from the [release
 page], or see these [install] notes. Then try one of
-the tested [demos].
+the tested [examples].
 
 ## Usage
 
@@ -126,16 +103,39 @@ you are a submodule fan).
 
 Generate YAML with
 
-```
+```sh
 kustomize build ~/someApp/overlays/production
 ```
 
 The YAML can be directly [applied] to a cluster:
 
-> ```
+> ```sh
 > kustomize build ~/someApp/overlays/production | kubectl apply -f -
 > ```
 
 ## About
 
 This tool is sponsored by [sig-cli] ([KEP]).
+
+
+[KEP]: https://github.com/kubernetes/community/blob/master/keps/sig-cli/0008-kustomize.md
+[`make`]: https://www.gnu.org/software/make
+[`sed`]: https://www.gnu.org/software/sed
+[applied]: docs/glossary.md#apply
+[base]: docs/glossary.md#base
+[declarative configuration]: docs/glossary.md#declarative-application-management
+[examples]: examples/README.md
+[imageBase]: docs/base.jpg
+[imageOverlay]: docs/overlay.jpg
+[install]: INSTALL.md
+[kubernetes style]: docs/glossary.md#kubernetes-style-object
+[kustomization]: docs/glossary.md#kustomization
+[overlay]: docs/glossary.md#overlay
+[overlays]: docs/glossary.md#overlay
+[release page]: https://github.com/kubernetes-sigs/kustomize/releases
+[resource]: docs/glossary.md#resource
+[resources]: docs/glossary.md#resource
+[sig-cli]: https://github.com/kubernetes/community/blob/master/sig-cli/README.md
+[variant]: docs/glossary.md#variant
+[variants]: docs/glossary.md#variant
+[workflows]: docs/workflows.md

bin/pre-commit.sh

@@ -43,14 +43,14 @@ function testGoTest {
   go test -v ./...
 }
 
-function testDemos {
-  mdrip --mode test --label test README.md ./demos
+function testExamples {
+  mdrip --mode test --label test README.md ./examples
 }
 
 runTest testGoFmt
 runTest testGoImports
 runTest testGoVet
 runTest testGoTest
-runTest testDemos
+runTest testExamples
 
 exit $rc

demos/README.md examples/README.mddemos/README.md renamed to examples/README.md

@@ -1,6 +1,6 @@
-# Demos
+# Examples
 
-These demos assume that `kustomize` is on your `$PATH`.
+These examples assume that `kustomize` is on your `$PATH`.
 
 They are covered by [pre-commit](../bin/pre-commit.sh)
 tests, and should work with HEAD

demos/breakfast.md examples/breakfast.mddemos/breakfast.md renamed to examples/breakfast.md

@@ -51,7 +51,7 @@ mkdir -p $BASE
 
 curl -s -o "$BASE/#1.yaml" "https://raw.githubusercontent.com\
 /kubernetes-sigs/kustomize\
-/master/demos/helloWorld\
+/master/examples/helloWorld\
 /{configMap,deployment,kustomization,service}.yaml"
 ```