Skip to content

Commit b69a7fc

Browse files
committed
Docs fixes for code blocks, links and minor typos
Add revisions for markdown changes Refactor link to relative path
1 parent e769e76 commit b69a7fc

File tree

6 files changed

+8
-11
lines changed

6 files changed

+8
-11
lines changed

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ func (r *CronJobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
6565
if cronJob.ObjectMeta.DeletionTimestamp.IsZero() {
6666
// The object is not being deleted, so if it does not have our finalizer,
6767
// then lets add the finalizer and update the object. This is equivalent
68-
// registering our finalizer.
68+
// to registering our finalizer.
6969
if !controllerutil.ContainsFinalizer(cronJob, myFinalizerName) {
7070
controllerutil.AddFinalizer(cronJob, myFinalizerName)
7171
if err := r.Update(ctx, cronJob); err != nil {
@@ -78,7 +78,7 @@ func (r *CronJobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
7878
// our finalizer is present, so lets handle any external dependency
7979
if err := r.deleteExternalResources(cronJob); err != nil {
8080
// if fail to delete the external dependency here, return with error
81-
// so that it can be retried
81+
// so that it can be retried.
8282
return ctrl.Result{}, err
8383
}
8484

@@ -105,4 +105,3 @@ func (r *Reconciler) deleteExternalResources(cronJob *batch.CronJob) error {
105105
// Ensure that delete implementation is idempotent and safe to invoke
106106
// multiple times for same object.
107107
}
108-

docs/book/src/multiversion-tutorial/api-changes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ schedule: "*/1 * * * *"
1212
That's a pretty textbook example of a special string format (it's also
1313
pretty unreadable unless you're a Unix sysadmin).
1414
15-
Let's make it a bit more structured. According to the our [CronJob
15+
Let's make it a bit more structured. According to our [CronJob
1616
code][cronjob-sched-code], we support "standard" Cron format.
1717
1818
In Kubernetes, **all versions must be safely round-tripable through each
@@ -52,4 +52,4 @@ Now, let's copy over our existing types, and make the change:
5252

5353
Now that we've got our types in place, we'll need to set up conversion...
5454

55-
[cronjob-sched-code]: /TODO.md
55+
[cronjob-sched-code]: ./multiversion-tutorial/testdata/project/api/v2/cronjob_types.go "CronJob Code"

docs/book/src/reference/completion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ if [ -f /usr/local/share/bash-completion/bash_completion ]; then
2727
fi
2828
. <(kubebuilder completion bash)
2929
```
30-
- Restart terminal for the changes to be reflected.
30+
- Restart terminal for the changes to be reflected or `source` the changed bash file.
3131

3232
<aside class="note">
3333
<h1>Zsh</h1>

docs/book/src/reference/platform.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ build and configure your workloads. This guide aims to help you properly configu
66
## Overview
77

88
To provide support on specific or multiple platforms, you must ensure that all images used in workloads are built to
9-
support the desired platforms. Note that may not be the same as the platform where you develop your solutions
10-
and use KubeBuilder, but instead the platform(s) where your solution should run and be distributed.
9+
support the desired platforms. Note that they may not be the same as the platform where you develop your solutions and use KubeBuilder, but instead the platform(s) where your solution should run and be distributed.
1110
It is recommended to build solutions that work on multiple platforms so that your project works
1211
on any Kubernetes cluster regardless of the underlying operating system and architecture.
1312

docs/book/src/reference/raising-events.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ type MyKindReconciler struct {
7676
Recorder record.EventRecorder
7777
}
7878
```
79-
8079
### Passing the EventRecorder to the Controller
8180

8281
Events are published from a Controller using an [EventRecorder]`type CorrelatorOptions struct`,

docs/book/src/reference/webhook-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Webhook
22

33
Webhooks are requests for information sent in a blocking fashion. A web
4-
application implementing webhooks will send an HTTP request to other application
5-
when certain event happens.
4+
application implementing webhooks will send a HTTP request to other applications
5+
when a certain event happens.
66

77
In the kubernetes world, there are 3 kinds of webhooks:
88
[admission webhook](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#admission-webhooks),

0 commit comments

Comments
 (0)