Skip to content

Commit 10145f5

Browse files
committed
Book typo fixes
A few typos or misformattings in the book existed. This fixes them.
1 parent 38200ab commit 10145f5

File tree

4 files changed

+9
-8
lines changed

4 files changed

+9
-8
lines changed

docs/book/src/cronjob-tutorial/epilogue.md

-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,4 @@
33
Things left to do:
44

55
- Write custom printer columns
6-
- Discuss webhooks
76
- Use different watches

docs/book/src/cronjob-tutorial/testdata/emptycontroller.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,10 @@ type CronJobReconciler struct {
4444
}
4545

4646
/*
47-
Most controllers eventually end up running on the cluster, so they need RBAC permissions.
48-
These are the bare minimum permissions needed to run. As we add more functionality, we'll
49-
need to revisit these.
47+
Most controllers eventually end up running on the cluster, so they need RBAC
48+
permissions, which we specify using controller-tools [RBAC
49+
markers](/reference/markers/rbac.md). These are the bare minimum permissions
50+
needed to run. As we add more functionality, we'll need to revisit these.
5051
*/
5152

5253
// +kubebuilder:rbac:groups=batch.tutorial.kubebuilder.io,resources=cronjobs,verbs=get;list;watch;create;update;patch;delete

docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ func ignoreNotFound(err error) error {
8787

8888
/*
8989
Notice that we need a few more RBAC permissions -- since we're creating and
90-
managing jobs now, we'll need permissions for those.
90+
managing jobs now, we'll need permissions for those, which means adding
91+
a couple more [markers](/reference/markers/rbac.md).
9192
*/
9293

9394
// +kubebuilder:rbac:groups=batch.tutorial.kubebuilder.io,resources=cronjobs,verbs=get;list;watch;create;update;patch;delete

docs/book/src/multiversion-tutorial/deployment.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ kubectl get disks.v2.infra.kubebuilder.io/disk-sample -o yaml
3434
```
3535

3636
```yaml
37-
apiVersion: infra.kubebuilder.io/v2 <-- note the v2 version
37+
apiVersion: infra.kubebuilder.io/v2 # <-- note the v2 version
3838
kind: Disk
3939
metadata:
4040
name: disk-sample
@@ -54,15 +54,15 @@ status: {}
5454
kubectl get disks.v3.infra.kubebuilder.io/disk-sample -o yaml
5555
```
5656
```yaml
57-
apiVersion: infra.kubebuilder.io/v3 <-- note the v3 version
57+
apiVersion: infra.kubebuilder.io/v3 # <-- note the v3 version
5858
kind: Disk
5959
metadata:
6060
name: disk-sample
6161
selfLink: /apis/infra.kubebuilder.io/v3/namespaces/default/disks/disk-sample
6262
uid: 0e9be0fd-a284-11e9-bbbe-42010a8001af <-- note the same uid as v2
6363
....
6464
spec:
65-
pricePerGB: <-- note the pricePerGB name of the field
65+
pricePerGB: # <-- note the pricePerGB name of the field
6666
amount: 10
6767
currency: USD
6868
status: {}

0 commit comments

Comments
 (0)