Merge pull request #1038 from droot/running/update-demo-movie

🏃 update the demo movie to 2.0.1 release

Author: k8s-ci-robot

README.md

@@ -18,7 +18,7 @@ Follow the [instructions](https://book.kubebuilder.io/quick-start.html#installat
 
 See the [Getting Started](https://book.kubebuilder.io/quick-start.html) documentation.
 
-![Quick Start](docs/gif/quickstart-1.0.0.gif)
+![Quick Start](docs/gif/kb-demo.v2.0.1.svg)
 
 ## Documentation
 

docs/gif/kb-demo.v2.0.1.svg

@@ -8,3 +8,24 @@ cd /tmp/kb-demo
 DEMO_AUTO_RUN=1 ./run.sh
 
 ```
+
+Instructions for producing the demo movie:
+
+```sh
+
+# Create temporary directory
+mkdir /tmp/kb-demo
+cd /tmp/kb-demo
+
+asciinema rec
+<path-to-KB-repo>/scripts/demo/run.sh
+
+<CTRL-C> to terminate the script
+<CTRL-D> to terminate the asciinema recording
+<CTRL-C> to save the recording locally
+
+# Edit the recorded file by editing the controller-gen path
+# Once you are happy with the recording, use svg-term program to generate the svg
+
+svg-term --cast=<movie-id> --out demo.svg --window
+```

scripts/demo/README.md

@@ -27,15 +27,15 @@ desc "Examine scaffolded files..."
 run "tree ."
 clear
 
-desc "Let's create cronjob api"
+desc "Create our custom cronjob api"
 run "kubebuilder create api --group batch --version v1 --kind CronJob"
 clear
 
 desc "Let's take a look at the API and Controller files"
 run "tree ./api ./controllers"
 clear
 
-desc "Install CRD in Kubernetes cluster"
+desc "Install CRDs in Kubernetes cluster"
 run "make install"
 clear