Merge pull request #159 from pwittrock/docs-gen

Upgrading Kubebuilder and Core Only Controller docs
kubernetes-sigs · May 15, 2018 · cb7ddfc · cb7ddfc
2 parents d3caa1d + 3c3ead8
commit cb7ddfc
Show file tree

Hide file tree

Showing 8 changed files with 72 additions and 8 deletions.
diff --git a/docs/book/RELEASE b/docs/book/RELEASE
@@ -0,0 +1,6 @@
+To push the docs run:
+
+- gitbook build
+- docker build . -t gcr.io/kubebuilder/book
+- docker push  gcr.io/kubebuilder/book
+- kubectl delete pods -l run=gitbook-prod
diff --git a/docs/book/SUMMARY.md b/docs/book/SUMMARY.md
@@ -14,8 +14,6 @@
 
 * Development Workflow
   * [Project Creation and Structure](basics/project_creation_and_structure.md)
-  * [Running Tests](basics/running_tests.md)
-  * [Generating API Documentation](basics/generating_documentation.md)
 * Resource Fundamentals
   * [What is a Resource](basics/what_is_a_resource.md)
   * [Simple Resource Example](basics/simple_resource.md)
@@ -28,5 +26,15 @@
   * [What is the Controller-Manager](basics/what_is_the_controller_manager.md)
   * [Simple Controller-Manager](basics/simple_controller_manager.md)
 
+### Beyond the Basics
+
+* Development Workflow
+  * [Running Tests](beyond_basics/running_tests.md)
+  * [Generating API Documentation](beyond_basics/generating_documentation.md)
+  * [Updating Kubebuilder](beyond_basics/upgrading_kubebuilder.md)
+* Controllers
+  * [Controllers For Core Resources](beyond_basics/controllers_for_core_resources.md)
+
+
 ### Reference Docs
 * [GoDoc Links](go_docs.md)
diff --git a/docs/book/beyond_basics/controllers_for_core_resources.md b/docs/book/beyond_basics/controllers_for_core_resources.md
@@ -0,0 +1,20 @@
+{% panel style="info", title="Under Development" %}
+This book is being actively developed.
+{% endpanel %}
+
+## Controllers for Core Resources
+
+{% method %}
+
+It it possible to create Controllers for Core resources, or for resources defined outside your project.
+
+{% sample lang="bash" %}
+```bash
+kubebuilder create controller --group apps --version v1beta2 --kind Deployment --core-type
+```
+{% endmethod %}
+
+{% panel style="warning", title="Core Only Projects" %}
+If your project will *only* contain controllers for types defined outside your project,
+you must create the project with the `--controller-only` flag.
+{% endpanel %}
diff --git a/docs/book/basics/generating_documentation.md → ...beyond_basics/generating_documentation.md b/docs/book/basics/generating_documentation.md → ...beyond_basics/generating_documentation.md
diff --git a/docs/book/basics/running_tests.md → docs/book/beyond_basics/running_tests.md b/docs/book/basics/running_tests.md → docs/book/beyond_basics/running_tests.md
diff --git a/docs/book/beyond_basics/upgrading_kubebuilder.md b/docs/book/beyond_basics/upgrading_kubebuilder.md
@@ -0,0 +1,26 @@
+{% panel style="info", title="Under Development" %}
+This book is being actively developed.
+{% endpanel %}
+
+# Update Kubebuilder
+
+## Update the Kubebuilder install
+
+Download the latest version of kubebuilder from [releases page](https://github.com/kubernetes-sigs/kubebuilder/releases)
+and install it.
+
+## Update Existing Project's Dependencies
+
+{% method %}
+
+Update your project's dependencies to the latest version of the libraries used by kubebuilder.  This
+will modify *Gopkg.toml* by rewriting the `[[override]]` elements beneath the
+`# DO NOT MODIFY BELOW THIS LINE.` line.  Rules added by the user above this line will be retained.
+
+{% sample lang="bash" %}
+```bash
+kubebuilder update vendor
+```
+{% endmethod %}
+
+
diff --git a/docs/book/getting_started/installation_and_setup.md b/docs/book/getting_started/installation_and_setup.md
@@ -23,11 +23,11 @@ Kubebuilder can then setup a project in the user's `GOPATH`.
 {% sample lang="mac" %}
 ```bash
 # download the release
-curl -L -O https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.8/kubebuilder_0.1.8_darwin_amd64.tar.gz
+curl -L -O https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.9/kubebuilder_0.1.9_darwin_amd64.tar.gz
 
 # extract the archive
-tar -zxvf kubebuilder_0.1.8_darwin_amd64.tar.gz
-sudo mv kubebuilder_0.1.8_darwin_amd64 /usr/local/kubebuilder
+tar -zxvf kubebuilder_0.1.9_darwin_amd64.tar.gz
+sudo mv kubebuilder_0.1.9_darwin_amd64 /usr/local/kubebuilder
 
 # update your PATH to include /usr/local/kubebuilder/bin
 export PATH=$PATH:/usr/local/kubebuilder/bin
@@ -36,11 +36,11 @@ export PATH=$PATH:/usr/local/kubebuilder/bin
 {% sample lang="linux" %}
 ```bash
 # download the release
-wget https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.8/kubebuilder_0.1.8_linux_amd64.tar.gz
+wget https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.9/kubebuilder_0.1.9_linux_amd64.tar.gz
 
 # extract the archive
-tar -zxvf kubebuilder_0.1.8_linux_amd64.tar.gz
-sudo mv kubebuilder_0.1.8_linux_amd64 /usr/local/kubebuilder
+tar -zxvf kubebuilder_0.1.9_linux_amd64.tar.gz
+sudo mv kubebuilder_0.1.9_linux_amd64 /usr/local/kubebuilder
 
 # update your PATH to include /usr/local/kubebuilder/bin
 export PATH=$PATH:/usr/local/kubebuilder/bin

diff --git a/docs/book/quick_start.md b/docs/book/quick_start.md
@@ -1,3 +1,7 @@
+{% panel style="info", title="Under Development" %}
+This book is being actively developed.
+{% endpanel %}
+
 # Quick Start
 
 This Quick Start guide will cover.