From 135461082a886895e1d405ce766be1b025b5c700 Mon Sep 17 00:00:00 2001 From: Phillip Wittrock Date: Thu, 10 May 2018 09:09:38 -0700 Subject: [PATCH] Update gitbook docs --- docs/book/basics/generating_documentation.md | 6 +++++- docs/book/getting_started/installation_and_setup.md | 12 ++++++------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/book/basics/generating_documentation.md b/docs/book/basics/generating_documentation.md index 0690fc8b321..69a55ffbe6e 100644 --- a/docs/book/basics/generating_documentation.md +++ b/docs/book/basics/generating_documentation.md @@ -13,7 +13,11 @@ directly in a web browser. {% panel style="info", title="Non-Kubebuilder Projects" %} Kubebuilder can also be used to generate API reference documentation for non-kubebuilder projects, as long as the -resources are annotated with `// +kubebuilder:resource` the same as they are in kubebuilder projects. +resources are annotated with `// +kubebuilder:resource:path=` the same as they are in kubebuilder +projects. + +**Important**: The `// +kubebuilder:resource` annotation *must* appear directly above the go struct +defining the resource. No blank lines may appear between the annotation and the go struct. {% endpanel %} ## Creating Examples diff --git a/docs/book/getting_started/installation_and_setup.md b/docs/book/getting_started/installation_and_setup.md index 51cae74b48f..1bef8b12170 100644 --- 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.7/kubebuilder_0.1.7_darwin_amd64.tar.gz +curl -L -O https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.8/kubebuilder_0.1.8_darwin_amd64.tar.gz # extract the archive -tar -zxvf kubebuilder_0.1.7_darwin_amd64.tar.gz -sudo mv kubebuilder_0.1.7_darwin_amd64 /usr/local/kubebuilder +tar -zxvf kubebuilder_0.1.8_darwin_amd64.tar.gz +sudo mv kubebuilder_0.1.8_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.7/kubebuilder_0.1.7_linux_amd64.tar.gz +wget https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.8/kubebuilder_0.1.8_linux_amd64.tar.gz # extract the archive -tar -zxvf kubebuilder_0.1.7_linux_amd64.tar.gz -sudo mv kubebuilder_0.1.7_linux_amd64 /usr/local/kubebuilder +tar -zxvf kubebuilder_0.1.8_linux_amd64.tar.gz +sudo mv kubebuilder_0.1.8_linux_amd64 /usr/local/kubebuilder # update your PATH to include /usr/local/kubebuilder/bin export PATH=$PATH:/usr/local/kubebuilder/bin