Skip to content

Commit 0a1357f

Browse files
committed
Fix up most of the TODO.md links
We had a few TODO.md links left over from when we were actively writing the docs. This cleans up all but the last few.
1 parent fb5789a commit 0a1357f

13 files changed

+45
-34
lines changed

docs/book/src/SUMMARY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
- [Reference](./reference/reference.md)
3535

36-
- [Generating CRD](./reference/generating-crd.md)
36+
- [Generating CRDs](./reference/generating-crd.md)
3737
- [Using Finalizers](./reference/using-finalizers.md)
3838
- [Kind cluster](reference/kind.md)
3939
- [What's a webhook?](reference/webhook-overview.md)

docs/book/src/cronjob-tutorial/api-design.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ number: `2.5` is `2500m`.
2929
There are two supported bases: 10 and 2 (called decimal and binary,
3030
respectively). Decimal base is indicated with "normal" SI suffixes (e.g.
3131
`M` and `K`), while Binary base is specified in "mebi" notation (e.g. `Mi`
32-
and `Ki`). Think [megabytes vs mebibytes](../TODO.md).
32+
and `Ki`). Think [megabytes vs
33+
mebibytes](https://en.wikipedia.org/wiki/Binary_prefix).
3334

3435
</details>
3536

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

+5-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ Each API group-version contains one or more API types, which we call
1919
be able to store all the data of the other forms, somehow (we can store
2020
the data in fields, or in annotations). This means that using an older
2121
API version won't cause newer data to be lost or corrupted. See the
22-
[Kubernetes API guidelines](../TODO.md) for more information.
22+
[Kubernetes API
23+
guidelines](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md)
24+
for more information.
2325

2426
You'll also hear mention of *resources* on occasion. A resource is simply
2527
a use of a Kind in the API. Often, there's a one-to-one mapping between
@@ -47,7 +49,8 @@ API!
4749
## Err, but what's that Scheme thing?
4850

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

5255
For instance, suppose we mark that the
5356
`"tutorial.kubebuilder.io/api/v1".CronJob{}` type as being in the

docs/book/src/cronjob-tutorial/main-revisited.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# You said something about main?
22

33
But first, remember how we said we'd [come back to `main.go`
4-
again](../TODO.md)? Let's take a look and see what's changed, and what we
5-
need to add.
4+
again](/cronjob-tutorial/empty-main.md)? Let's take a look and see what's
5+
changed, and what we need to add.
66

77
{{#literatego ./testdata/project/main.go}}
88

docs/book/src/cronjob-tutorial/new-api.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ kubebuilder create api --group batch --version v1 --kind CronJob
1111
The first time we call this command for each group-version, it will create
1212
a directory for the new group-version.
1313

14-
In this case, the [`api/v1/`](../TODO.md) directory is created,
15-
corresponding to the `batch.tutorial.kubebuilder.io/v1` (remember our
16-
[`--domain` setting](cronjob-tutorial.md#scaffolding-out-our-project)
17-
from the beginning?).
14+
In this case, the
15+
[`api/v1/`](https://sigs.k8s.io/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project/api/v1)
16+
directory is created, corresponding to the
17+
`batch.tutorial.kubebuilder.io/v1` (remember our [`--domain`
18+
setting](cronjob-tutorial.md#scaffolding-out-our-project) from the
19+
beginning?).
1820

1921
It has also added a file for our `CronJob` Kind,
2022
`api/v1/cronjob_types.go`. Each time we call the command with a different

docs/book/src/cronjob-tutorial/other-api-files.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# A Brief Aside: What's the rest of this stuff?
22

33
If you've taken a peek at the rest of the files in the
4-
[`api/v1/`](../TODO.md) directory, you might have noticed two additional
5-
files beyond `cronjob_types.go`: `groupversion_info.go` and
6-
`zz_generated.deepcopy.go`.
4+
[`api/v1/`](https://sigs.k8s.io/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project/api/v1)
5+
directory, you might have noticed two additional files beyond
6+
`cronjob_types.go`: `groupversion_info.go` and `zz_generated.deepcopy.go`.
77

88
Neither of these files ever needs to be edited (the former stays the same
99
and the latter is autogenerated), but it's useful to know what's in them.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
To test out the controller, we can run it locally against the cluster.
44
Before we do so, though, we'll need to install our CRDs, as per the [quick
5-
start](../TODO.md). This will automatically update the YAML manifests
6-
using controller-tools, if needed:
5+
start](/quick-start.md). This will automatically update the YAML
6+
manifests using controller-tools, if needed:
77

88
```bash
99
make install

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

+4-3
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,10 @@ some changes.
6363
6464
Most controllers need a logging handle and a context, so we set them up here.
6565
66-
The [context](../TODO.md) is used to allow cancelation of requests, and potentially
67-
things like tracing. It's the first argument to all client methods. The `Background`
68-
context is just a basic context without any extra data or timing restrictions.
66+
The [context](https://golang.org/pkg/context/) is used to allow cancelation of
67+
requests, and potentially things like tracing. It's the first argument to all
68+
client methods. The `Background` context is just a basic context without any
69+
extra data or timing restrictions.
6970
7071
The logging handle lets us log. controller-runtime uses structured logging through a
7172
library called [logr](https://github.com/go-logr/logr). As we'll see shortly,

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

+6-4
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ limitations under the License.
1818
1919
Our package starts out with some basic imports. Particularly:
2020
21-
- The core [controller-runtime](../TODO.md) library
21+
- The core [controller-runtime](https://godoc.org/sigs.k8s.io/controller-runtime) library
2222
- The default controller-runtime logging, Zap (more on that a bit later)
2323
2424
*/
@@ -37,9 +37,11 @@ import (
3737
)
3838

3939
/*
40-
Every set of controllers needs a [*Scheme*](../TODO.md), which provides mappings
41-
between Kinds and their corresponding Go types. We'll talk a bit more about Kinds
42-
when we write our API definition, so just keep this in mind for later.
40+
Every set of controllers needs a
41+
[*Scheme*](https://book.kubebuilder.io/cronjob-tutorial/gvks.html#err-but-whats-that-scheme-thing),
42+
which provides mappings between Kinds and their corresponding Go types. We'll
43+
talk a bit more about Kinds when we write our API definition, so just keep this
44+
in mind for later.
4345
*/
4446
var (
4547
scheme = runtime.NewScheme()

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,8 @@ Some fields are declaratively validated by OpenAPI schema.
155155
You can find kubebuilder validation markers (prefixed
156156
with `// +kubebuilder:validation`) in the [API](api-design.md)
157157
You can find all of the kubebuilder supported markers for
158-
declaring validation in [here](../TODO.md).
158+
declaring validation by running `controller-gen crd -w`,
159+
or [here](../TODO.md).
159160
*/
160161

161162
func (r *CronJob) validateCronJobSpec() *field.Error {

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

+6-4
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,12 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
109109
/*
110110
### 1: Load the CronJob by name
111111
112-
We'll fetch the CronJob using our client. All client methods take a context
113-
(to allow for cancellation) as their first argument, and the object in question
114-
as their last. Get is a bit special, in that it takes a [`NamespacedName`](../TODO.md)
115-
as the middle argument (most don't have a middle argument, as we'll see below).
112+
We'll fetch the CronJob using our client. All client methods take a
113+
context (to allow for cancellation) as their first argument, and the object
114+
in question as their last. Get is a bit special, in that it takes a
115+
[`NamespacedName`](https://godoc.org/sigs.k8s.io/controller-runtime/pkg/client#ObjectKey)
116+
as the middle argument (most don't have a middle argument, as we'll see
117+
below).
116118
117119
Many client methods also take variadic options at the end.
118120
*/

docs/book/src/quick-start.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ kubebuilder create api --group webapp --version v1 --kind Guestbook
6666
This will create the files `api/v1/guestbook_types.go` and
6767
`controller/guestbook_controller.go` for you to edit.
6868

69-
**Optional:** Edit the API definition or the reconciliation business logic.
70-
For more on this see [What is
71-
a Controller](cronjob-tutorial/controller-overview.html) and [What is
72-
a Resource](TODO.md)
69+
**Optional:** Edit the API definition or the reconciliation business
70+
logic. For more on this see [What's in
71+
a Controller](cronjob-tutorial/controller-overview.md) and [Designing an
72+
API](/cronjob-tutorial/api-design.md).
7373

7474
## Test It Out Locally
7575

docs/book/src/reference/generating-crd.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Generating CRD
1+
# Generating CRDs
22

33
Kubebuilder provides a tool named `controller-gen` to generate manifests for CustomResourceDefinitions. The tool resides in the [controller-tools](http://sigs.k8s.io/controller-tools) repository and is installed through a Makefile target called `controller-gen`.
44

@@ -147,5 +147,4 @@ the following:
147147

148148
- Set `CRD_OPTIONS ?= "crd:trivialVersions=false"` in the Makefile
149149
- Annotate the Go struct with marker `// +kubebuilder:storageversion` for the
150-
indicating the storage version. Read [more](../TODO.md) for supporting
151-
multiple versions in your project
150+
indicating the storage version.

0 commit comments

Comments
 (0)