Skip to content

Commit e24520f

Browse files
committed
Clean up last few TODO links
This cleans up the last few links that were just waiting to be filled in, plus a TODO block to embed a file in the multiversion tutorial.
1 parent be13268 commit e24520f

File tree

3 files changed

+18
-12
lines changed

3 files changed

+18
-12
lines changed

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,11 @@ At this point, our main function is fairly simple:
5858
5959
- We set up some basic flags for metrics.
6060
61-
- We instantiate a [*manager*](../TODO.md), which keeps track of running all of
62-
our controllers, as well as setting up shared caches and clients to the API
63-
server (notice we tell the manager about our Scheme).
61+
- We instantiate a
62+
[*manager*](https://godoc.org/sigs.k8s.io/controller-runtime/pkg/manager#Manager),
63+
which keeps track of running all of our controllers, as well as setting up
64+
shared caches and clients to the API server (notice we tell the manager about
65+
our Scheme).
6466
6567
- We run our manager, which in turn runs all of our controllers and webhooks.
6668
The manager is set up to run until it receives a graceful shutdown signal.

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

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ func (r *CronJob) SetupWebhookWithManager(mgr ctrl.Manager) error {
5050

5151
/*
5252
Notice that we use kubebuilder markers to generate webhook manifests.
53-
This markers is responsible for generating a mutating webhook manifest.
53+
This marker is responsible for generating a mutating webhook manifest.
5454
55-
The meaning of each marker can be found [here](../TODO.md).
55+
The meaning of each marker can be found [here](/reference/markers/webhook.md).
5656
*/
5757

5858
// +kubebuilder:webhook:path=/mutate-batch-tutorial-kubebuilder-io-v1-cronjob,mutating=true,failurePolicy=fail,groups=batch.tutorial.kubebuilder.io,resources=cronjobs,verbs=create;update,versions=v1,name=mcronjob.kb.io
@@ -87,10 +87,7 @@ func (r *CronJob) Default() {
8787
}
8888

8989
/*
90-
Notice that we use kubebuilder markers to generate webhook manifests.
91-
This markers is responsible for generating a validating webhook manifest.
92-
93-
The meaning of each marker can be found [here](../TODO.md).
90+
This marker is responsible for generating a validating webhook manifest.
9491
*/
9592

9693
// +kubebuilder:webhook:path=/validate-batch-tutorial-kubebuilder-io-v1-cronjob,mutating=false,failurePolicy=fail,groups=batch.tutorial.kubebuilder.io,resources=cronjobs,verbs=create;update,versions=v1,name=vcronjob.kb.io
@@ -156,7 +153,7 @@ You can find kubebuilder validation markers (prefixed
156153
with `// +kubebuilder:validation`) in the [API](api-design.md)
157154
You can find all of the kubebuilder supported markers for
158155
declaring validation by running `controller-gen crd -w`,
159-
or [here](../TODO.md).
156+
or [here](/reference/markers/crd-validation.md).
160157
*/
161158

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

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Let's take a quick look at the `api/v1/disk_webhook.go` file.
154154

155155
If you look at `main.go`, you will notice the following snippet that invokes the
156156
SetupWebhook method.
157-
```Go
157+
```go
158158
.....
159159

160160
if err = (&infrav1.Disk{}).SetupWebhookWithManager(mgr); err != nil {
@@ -176,7 +176,14 @@ CRD_OPTIONS ?= "crd:trivialVersions=false"
176176
```
177177

178178
Run `make manifests` to ensure that CRD manifests gets generated under `config/crd/bases/` directory.
179-
[TODO](../TODO.md) embed a compressed form of the generated CRD `testdata/project/config/crd`
179+
180+
<details><summary>`infra.kubebuilder.io_disks.yaml`: the generated CRD YAML</summary>
181+
182+
```yaml
183+
{{#include ./testdata/project/config/crd/bases/infra.kubebuilder.io_disks.yaml}}
184+
```
185+
186+
</details>
180187

181188
### Manifests Generation
182189

0 commit comments

Comments
 (0)