Skip to content

Commit 11e1b13

Browse files
authored
Merge pull request #804 from ljdelight/bookLinks
📖 replace some todo links to the documentation
2 parents ac48e99 + 1214703 commit 11e1b13

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

docs/book/src/cronjob-tutorial/controller-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ matches the desired state in the object. Each controller focuses on one
1111
We call this process *reconciling*.
1212

1313
In controller-runtime, the logic that implements the reconciling for
14-
a specific kind is called a [*Reconciler*](../TODO.md). A reconciler
14+
a specific kind is called a [*Reconciler*](https://godoc.org/sigs.k8s.io/controller-runtime/pkg/reconcile). A reconciler
1515
takes the name of an object, and returns whether or not we need to try
1616
again (e.g. in case of errors or periodic controllers, like the
1717
HorizontalPodAutoscaler).

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ In general, we never modify either of these -- all modifications go in either Sp
6161
6262
That little `+kubebuilder:object:root` comment is called a marker. We'll see
6363
more of them in a bit, but know that they act as extra metadata, telling
64-
[controller-tools](../TODO.md) (our code and YAML generator) extra information.
64+
[controller-tools](https://github.com/kubernetes-sigs/controller-tools) (our code and YAML generator) extra information.
6565
This particular one tells the `object` generator that this type represents
6666
a Kind. Then, the `object` generator generates an implementation of the
67-
[`runtime.Object`](../TODO.md) interface for us, which is the standard
67+
[runtime.Object](https://godoc.org/k8s.io/apimachinery/pkg/runtime#Object) interface for us, which is the standard
6868
interface that all types representing Kinds must implement.
6969
*/
7070

@@ -90,7 +90,7 @@ type CronJobList struct {
9090

9191
/*
9292
Finally, we add the Go types to the API group. This allows us to add the
93-
types in this API group to any [scheme](../TODO.md).
93+
types in this API group to any [Scheme](https://godoc.org/k8s.io/apimachinery/pkg/runtime#Scheme).
9494
*/
9595
func init() {
9696
SchemeBuilder.Register(&CronJob{}, &CronJobList{})

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ need to revisit these.
5454

5555
/*
5656
`Reconcile` actually performs the reconciling for a single named object.
57-
Our [`Request`](../TODO.md) just has a name, but we can use the client to fetch
57+
Our [Request](https://godoc.org/sigs.k8s.io/controller-runtime/pkg/reconcile#Request) just has a name, but we can use the client to fetch
5858
that object from the cache.
5959
60-
We return a empty result and no error, which indicates to controller-runtime that
60+
We return an empty result and no error, which indicates to controller-runtime that
6161
we've succesfully reconciled this object and don't need to try again until there's
6262
some changes.
6363

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ First, let's take a look at our spec. As we discussed before, spec holds
3434
Fundamentally a CronJob needs the following pieces:
3535
3636
- A schedule (the *cron* in CronJob)
37-
- A template to for the Job to run (the
37+
- A template for the Job to run (the
3838
*job* in CronJob)
3939
4040
We'll also want a few extras, which will make our users' lives easier:
4141
4242
- A deadline for starting jobs (if we miss this deadline, we'll just wait till
4343
the next scheduled time)
44-
- What do to if multiple jobs would run at once (do we wait? stop the old one? run both?)
44+
- What to do if multiple jobs would run at once (do we wait? stop the old one? run both?)
4545
- A way to pause the running of a CronJob, in case something's wrong with it
4646
- Limits on old job history
4747
@@ -50,7 +50,7 @@ keep track of whether a job has run. We can use at least one old job to do
5050
this.
5151
5252
We'll use several markers (`// +comment`) to specify additional metadata. These
53-
will be used by [controller-tools](../TODO.md) when generating our CRD manifest.
53+
will be used by [controller-tools](https://github.com/kubernetes-sigs/controller-tools) when generating our CRD manifest.
5454
As we'll see in a bit, controller-tools will also use GoDoc to form descriptions for
5555
the fields.
5656
*/

0 commit comments

Comments
 (0)