Address PR comments

kubernetes-sigs · May 14, 2018 · 62a532e · 62a532e
1 parent a48f937
commit 62a532e
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,10 @@ Kubebuilder is a framework for building Kubernetes APIs using [custom resource d
 **Note:** kubebuilder does not exist as an example to *copy-paste*, but instead provides powerful libraries and tools
 to simplify building and publishing Kubernetes APIs from scratch.
 
+#### Project Quick Start
+
+![Quick Start](docs/gif/quickstart.gif)
+
 
 ## Motivation
 

diff --git a/docs/book/basics/simple_controller.md b/docs/book/basics/simple_controller.md
@@ -31,6 +31,12 @@ ContainerSetController has 3 annotations:
   This will ensure the Kubernetes ServiceAccount running the controller can read / write to the Deployment API
 - `// +kubebuilder:informers` starts the informer for listening to Deployment events
 
+{% panel style="warning", title="Updating Annotations" %}
+It is necessary to update the `informers` and `rbac` annotations after adding watches or
+CRUD operations to your controller.  After updating the annotations, `kubebuilder generate`
+must be run to update generated code.
+{% endpanel %}
+
 ContainerSetController has 2 variables:
 
 - `InjectArgs` contains the clients provided to *ProvideController*

diff --git a/docs/gif/implementapi.gif b/docs/gif/implementapi.gif
diff --git a/docs/gif/quickstart.gif b/docs/gif/quickstart.gif