Skip to content

Commit 1354610

Browse files
committed
Update gitbook docs
1 parent 9836a2c commit 1354610

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

docs/book/basics/generating_documentation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ directly in a web browser.
1313

1414
{% panel style="info", title="Non-Kubebuilder Projects" %}
1515
Kubebuilder can also be used to generate API reference documentation for non-kubebuilder projects, as long as the
16-
resources are annotated with `// +kubebuilder:resource` the same as they are in kubebuilder projects.
16+
resources are annotated with `// +kubebuilder:resource:path=<resource-name>` the same as they are in kubebuilder
17+
projects.
18+
19+
**Important**: The `// +kubebuilder:resource` annotation *must* appear directly above the go struct
20+
defining the resource. No blank lines may appear between the annotation and the go struct.
1721
{% endpanel %}
1822

1923
## Creating Examples

docs/book/getting_started/installation_and_setup.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ Kubebuilder can then setup a project in the user's `GOPATH`.
2323
{% sample lang="mac" %}
2424
```bash
2525
# download the release
26-
curl -L -O https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.7/kubebuilder_0.1.7_darwin_amd64.tar.gz
26+
curl -L -O https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.8/kubebuilder_0.1.8_darwin_amd64.tar.gz
2727

2828
# extract the archive
29-
tar -zxvf kubebuilder_0.1.7_darwin_amd64.tar.gz
30-
sudo mv kubebuilder_0.1.7_darwin_amd64 /usr/local/kubebuilder
29+
tar -zxvf kubebuilder_0.1.8_darwin_amd64.tar.gz
30+
sudo mv kubebuilder_0.1.8_darwin_amd64 /usr/local/kubebuilder
3131

3232
# update your PATH to include /usr/local/kubebuilder/bin
3333
export PATH=$PATH:/usr/local/kubebuilder/bin
@@ -36,11 +36,11 @@ export PATH=$PATH:/usr/local/kubebuilder/bin
3636
{% sample lang="linux" %}
3737
```bash
3838
# download the release
39-
wget https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.7/kubebuilder_0.1.7_linux_amd64.tar.gz
39+
wget https://github.com/kubernetes-sigs/kubebuilder/releases/download/v0.1.8/kubebuilder_0.1.8_linux_amd64.tar.gz
4040

4141
# extract the archive
42-
tar -zxvf kubebuilder_0.1.7_linux_amd64.tar.gz
43-
sudo mv kubebuilder_0.1.7_linux_amd64 /usr/local/kubebuilder
42+
tar -zxvf kubebuilder_0.1.8_linux_amd64.tar.gz
43+
sudo mv kubebuilder_0.1.8_linux_amd64 /usr/local/kubebuilder
4444

4545
# update your PATH to include /usr/local/kubebuilder/bin
4646
export PATH=$PATH:/usr/local/kubebuilder/bin

0 commit comments

Comments
 (0)