Skip to content

Commit

Permalink
fixed some typos in the book
Browse files Browse the repository at this point in the history
  • Loading branch information
sbueringer committed Aug 10, 2019
1 parent 17f261a commit 8defb79
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/book/src/cronjob-tutorial/epilogue.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Additionally, you can try the following steps on your own -- we'll have
a tutorial section on them Soon™:

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/cronjob-tutorial/gvks.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ API!
## Err, but what's that Scheme thing?

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

For instance, suppose we mark that the
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/cronjob-tutorial/testdata/emptycontroller.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Our [Request](https://godoc.org/sigs.k8s.io/controller-runtime/pkg/reconcile#Req
that object from the cache.
We return an empty result and no error, which indicates to controller-runtime that
we've succesfully reconciled this object and don't need to try again until there's
we've successfully reconciled this object and don't need to try again until there's
some changes.
Most controllers need a logging handle and a context, so we set them up here.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ const (
Next, let's design our status, which holds observed state. It contains any information
we want users or other controllers to be able to easily obtain.
We'll keep a list of actively running jobs, as well as the last time that we succesfully
We'll keep a list of actively running jobs, as well as the last time that we successfully
ran our job. Notice that we use `metav1.Time` instead of `time.Time` to get the stable
serialization, as mentioned above.
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/multiversion-tutorial/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Normally, we'd run
kubebuilder create webhook --group batch --version v1 --kind CronJob --conversion
```

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

## Webhook setup...
Expand Down
6 changes: 3 additions & 3 deletions docs/book/src/reference/markers.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
KubeBuilder makes use of a tool called `controller-gen` (from
[controller-tools](https://godoc.org/sigs.k8s.io/controller-tools)) for
generating utility code and Kubernetes YAML. This code and config
generation is controlled by the presenence of special "marker comments" in
generation is controlled by the presence of special "marker comments" in
Go code.

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/reference/markers/object.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Object/DeepCopy

These markers control when `DeepCopy` and `runtime.Object` implemention
These markers control when `DeepCopy` and `runtime.Object` implementation
methods are generated.

{{#markerdocs object}}
6 changes: 3 additions & 3 deletions docs/book/utils/litgo/literate.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import (

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

// bookSrcDir is the absoulte book source path
// bookSrcDir is the absolute book source path
bookSrcDir string
}

// FullPath resturns the full, absolute path to the given file on the source filesystem.
// FullPath returns the full, absolute path to the given file on the source filesystem.
func (f filePathInfo) FullPath() string {
return filepath.Join(f.bookSrcDir, f.chapterDir, f.chapterRelativePath)
}
Expand Down
2 changes: 1 addition & 1 deletion docs/book/utils/plugin/input.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ type BookSection struct {
}

// BookItem is an mdBook item.
// It wraps an underlying struct to provide proper marshalling and unmarhsaling
// It wraps an underlying struct to provide proper marshalling and unmarshalling
// according to what serde produces/expects.
type BookItem bookItem

Expand Down
2 changes: 1 addition & 1 deletion docs/book/utils/plugin/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func EachCommand(book *Book, cmd string, callback func(chapter *BookChapter, arg
return nil
}

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

0 comments on commit 8defb79

Please sign in to comment.