Skip to content

Commit 8defb79

Browse files
committed
fixed some typos in the book
1 parent 17f261a commit 8defb79

File tree

10 files changed

+14
-14
lines changed

10 files changed

+14
-14
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Additionally, you can try the following steps on your own -- we'll have
1212
a tutorial section on them Soon™:
1313

1414
- writing unit/integration tests (check out [envtest][envtest])
15-
- adding [additonal printer columns][printer-columns] `kubectl get`
15+
- adding [additional printer columns][printer-columns] `kubectl get`
1616

1717
[envtest]: https://godoc.org/sigs.k8s.io/controller-runtime/pkg/envtest
1818

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ API!
4949
## Err, but what's that Scheme thing?
5050

5151
The `Scheme` we saw before is simply a way to keep track of what Go type
52-
corresponds to a given GVK (don't be overwhelemed by its
52+
corresponds to a given GVK (don't be overwhelmed by its
5353
[godocs](https://godoc.org/k8s.io/apimachinery/pkg/runtime#Scheme)).
5454

5555
For instance, suppose we mark that the

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Our [Request](https://godoc.org/sigs.k8s.io/controller-runtime/pkg/reconcile#Req
5959
that object from the cache.
6060
6161
We return an empty result and no error, which indicates to controller-runtime that
62-
we've succesfully reconciled this object and don't need to try again until there's
62+
we've successfully reconciled this object and don't need to try again until there's
6363
some changes.
6464
6565
Most controllers need a logging handle and a context, so we set them up here.

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_types.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ const (
130130
Next, let's design our status, which holds observed state. It contains any information
131131
we want users or other controllers to be able to easily obtain.
132132
133-
We'll keep a list of actively running jobs, as well as the last time that we succesfully
133+
We'll keep a list of actively running jobs, as well as the last time that we successfully
134134
ran our job. Notice that we use `metav1.Time` instead of `time.Time` to get the stable
135135
serialization, as mentioned above.
136136
*/

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Normally, we'd run
99
kubebuilder create webhook --group batch --version v1 --kind CronJob --conversion
1010
```
1111

12-
to scaffold out the wehbook setup. However, we've already got webhook
12+
to scaffold out the webhook setup. However, we've already got webhook
1313
setup, from when we built our defaulting and validating webhooks!
1414

1515
## Webhook setup...

docs/book/src/reference/markers.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
KubeBuilder makes use of a tool called `controller-gen` (from
44
[controller-tools](https://godoc.org/sigs.k8s.io/controller-tools)) for
55
generating utility code and Kubernetes YAML. This code and config
6-
generation is controlled by the presenence of special "marker comments" in
6+
generation is controlled by the presence of special "marker comments" in
77
Go code.
88

99
Markers are single-line comments that start with a plus, followed by
@@ -59,10 +59,10 @@ ints, and bools follow their Go syntax:
5959
```go
6060
// +kubebuilder:validation:ExclusiveMaximum=false
6161
// +kubebulder:validation:Format="date-time"
62-
// +kubebuilder:validation:Maxium=42
62+
// +kubebuilder:validation:Maximum=42
6363
```
6464

65-
For convinience, in simple cases the quotes may be omitted from strings,
65+
For convenience, in simple cases the quotes may be omitted from strings,
6666
although this is not encouraged for anything other than single-word
6767
strings:
6868

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Object/DeepCopy
22

3-
These markers control when `DeepCopy` and `runtime.Object` implemention
3+
These markers control when `DeepCopy` and `runtime.Object` implementation
44
methods are generated.
55

66
{{#markerdocs object}}

docs/book/utils/litgo/literate.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import (
3434

3535
// Literate is a plugin that extracts block comments from Go source and
3636
// interleaves them with the surrounding code as fenced code blocks.
37-
// It should suppot all output formats.
37+
// It should support all output formats.
3838
// It's triggered by using the an expression like `{{#literatego ./path/to/source/file.go}}`.
3939
// The marker `+kubebuilder:docs-gen:collapse=<string>` can be used to collapse a description/code
4040
// pair into a details block with the given summary.
@@ -75,11 +75,11 @@ type filePathInfo struct {
7575
// chapterDir is the directory of the chapter, relative to bookSrcDir
7676
chapterDir string
7777

78-
// bookSrcDir is the absoulte book source path
78+
// bookSrcDir is the absolute book source path
7979
bookSrcDir string
8080
}
8181

82-
// FullPath resturns the full, absolute path to the given file on the source filesystem.
82+
// FullPath returns the full, absolute path to the given file on the source filesystem.
8383
func (f filePathInfo) FullPath() string {
8484
return filepath.Join(f.bookSrcDir, f.chapterDir, f.chapterRelativePath)
8585
}

docs/book/utils/plugin/input.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ type BookSection struct {
4848
}
4949

5050
// BookItem is an mdBook item.
51-
// It wraps an underlying struct to provide proper marshalling and unmarhsaling
51+
// It wraps an underlying struct to provide proper marshalling and unmarshalling
5252
// according to what serde produces/expects.
5353
type BookItem bookItem
5454

docs/book/utils/plugin/utils.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func EachCommand(book *Book, cmd string, callback func(chapter *BookChapter, arg
3131
return nil
3232
}
3333

34-
// figure out all the trigger expressins
34+
// figure out all the trigger expressions
3535
partsRaw := strings.Split(chapter.Content, cmdStart)
3636
// the first section won't start with `{{#<cmd> ` as per how split works
3737
if len(partsRaw) < 2 {

0 commit comments

Comments
 (0)