File tree Expand file tree Collapse file tree 2 files changed +11
-7
lines changed Expand file tree Collapse file tree 2 files changed +11
-7
lines changed Original file line number Diff line number Diff line change @@ -13,7 +13,11 @@ directly in a web browser.
13
13
14
14
{% panel style="info", title="Non-Kubebuilder Projects" %}
15
15
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.
17
21
{% endpanel %}
18
22
19
23
## Creating Examples
Original file line number Diff line number Diff line change @@ -23,11 +23,11 @@ Kubebuilder can then setup a project in the user's `GOPATH`.
23
23
{% sample lang="mac" %}
24
24
``` bash
25
25
# 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
27
27
28
28
# 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
31
31
32
32
# update your PATH to include /usr/local/kubebuilder/bin
33
33
export PATH=$PATH :/usr/local/kubebuilder/bin
@@ -36,11 +36,11 @@ export PATH=$PATH:/usr/local/kubebuilder/bin
36
36
{% sample lang="linux" %}
37
37
``` bash
38
38
# 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
40
40
41
41
# 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
44
44
45
45
# update your PATH to include /usr/local/kubebuilder/bin
46
46
export PATH=$PATH :/usr/local/kubebuilder/bin
You can’t perform that action at this time.
0 commit comments