Merge pull request #867 from DirectXMan12/docs/cleanup-last-todo-links

k8s-ci-robot · web-flow · commit 2c63b5d21d6d · 2019-07-18T13:46:19.000-07:00
📖 Fix up most of the TODO.md links
diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
@@ -33,7 +33,7 @@
 
 - [Reference](./reference/reference.md)
 
-  - [Generating CRD](./reference/generating-crd.md)
+  - [Generating CRDs](./reference/generating-crd.md)
   - [Using Finalizers](./reference/using-finalizers.md)
   - [Kind cluster](reference/kind.md)
   - [What's a webhook?](reference/webhook-overview.md)
diff --git a/docs/book/src/cronjob-tutorial/api-design.md b/docs/book/src/cronjob-tutorial/api-design.md
@@ -29,7 +29,8 @@ number: `2.5` is `2500m`.
 There are two supported bases: 10 and 2 (called decimal and binary,
 respectively).  Decimal base is indicated with "normal" SI suffixes (e.g.
 `M` and `K`), while Binary base is specified in "mebi" notation (e.g. `Mi`
-and `Ki`).  Think [megabytes vs mebibytes](../TODO.md).
+and `Ki`).  Think [megabytes vs
+mebibytes](https://en.wikipedia.org/wiki/Binary_prefix).
 
 </details>
 
diff --git a/docs/book/src/cronjob-tutorial/gvks.md b/docs/book/src/cronjob-tutorial/gvks.md
@@ -19,7 +19,9 @@ Each API group-version contains one or more API types, which we call
 be able to store all the data of the other forms, somehow (we can store
 the data in fields, or in annotations).  This means that using an older
 API version won't cause newer data to be lost or corrupted.  See the
-[Kubernetes API guidelines](../TODO.md) for more information.
+[Kubernetes API
+guidelines](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md)
+for more information.
 
 You'll also hear mention of *resources* on occasion.  A resource is simply
 a use of a Kind in the API.  Often, there's a one-to-one mapping between
@@ -47,7 +49,8 @@ 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.
+corresponds to a given GVK (don't be overwhelemed by its
+[godocs](https://godoc.org/k8s.io/apimachinery/pkg/runtime#Scheme)).
 
 For instance, suppose we mark that the
 `"tutorial.kubebuilder.io/api/v1".CronJob{}` type as being in the
diff --git a/docs/book/src/cronjob-tutorial/main-revisited.md b/docs/book/src/cronjob-tutorial/main-revisited.md
@@ -1,8 +1,8 @@
 # You said something about main?
 
 But first, remember how we said we'd [come back to `main.go`
-again](../TODO.md)?  Let's take a look and see what's changed, and what we
-need to add.
+again](/cronjob-tutorial/empty-main.md)? Let's take a look and see what's
+changed, and what we need to add.
 
 {{#literatego ./testdata/project/main.go}}
 
diff --git a/docs/book/src/cronjob-tutorial/new-api.md b/docs/book/src/cronjob-tutorial/new-api.md
@@ -11,10 +11,12 @@ kubebuilder create api --group batch --version v1 --kind CronJob
 The first time we call this command for each group-version, it will create
 a directory for the new group-version.
 
-In this case, the [`api/v1/`](../TODO.md) directory is created,
-corresponding to the `batch.tutorial.kubebuilder.io/v1` (remember our
-[`--domain` setting](cronjob-tutorial.md#scaffolding-out-our-project)
-from the beginning?).
+In this case, the
+[`api/v1/`](https://sigs.k8s.io/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project/api/v1)
+directory is created, corresponding to the
+`batch.tutorial.kubebuilder.io/v1` (remember our [`--domain`
+setting](cronjob-tutorial.md#scaffolding-out-our-project) from the
+beginning?).
 
 It has also added a file for our `CronJob` Kind,
 `api/v1/cronjob_types.go`.  Each time we call the command with a different
diff --git a/docs/book/src/cronjob-tutorial/other-api-files.md b/docs/book/src/cronjob-tutorial/other-api-files.md
@@ -1,9 +1,9 @@
 # A Brief Aside: What's the rest of this stuff?
 
 If you've taken a peek at the rest of the files in the
-[`api/v1/`](../TODO.md) directory, you might have noticed two additional
-files beyond `cronjob_types.go`: `groupversion_info.go` and
-`zz_generated.deepcopy.go`.
+[`api/v1/`](https://sigs.k8s.io/kubebuilder/docs/book/src/cronjob-tutorial/testdata/project/api/v1)
+directory, you might have noticed two additional files beyond
+`cronjob_types.go`: `groupversion_info.go` and `zz_generated.deepcopy.go`.
 
 Neither of these files ever needs to be edited (the former stays the same
 and the latter is autogenerated), but it's useful to know what's in them.
diff --git a/docs/book/src/cronjob-tutorial/running.md b/docs/book/src/cronjob-tutorial/running.md
@@ -2,8 +2,8 @@
 
 To test out the controller, we can run it locally against the cluster.
 Before we do so, though, we'll need to install our CRDs, as per the [quick
-start](../TODO.md).  This will automatically update the YAML manifests
-using controller-tools, if needed:
+start](/quick-start.md).  This will automatically update the YAML
+manifests using controller-tools, if needed:
 
 ```bash
 make install
diff --git a/docs/book/src/cronjob-tutorial/testdata/emptycontroller.go b/docs/book/src/cronjob-tutorial/testdata/emptycontroller.go
@@ -63,9 +63,10 @@ some changes.
 
 Most controllers need a logging handle and a context, so we set them up here.
 
-The [context](../TODO.md) is used to allow cancelation of requests, and potentially
-things like tracing.  It's the first argument to all client methods.  The `Background`
-context is just a basic context without any extra data or timing restrictions.
+The [context](https://golang.org/pkg/context/) is used to allow cancelation of
+requests, and potentially things like tracing.  It's the first argument to all
+client methods.  The `Background` context is just a basic context without any
+extra data or timing restrictions.
 
 The logging handle lets us log.  controller-runtime uses structured logging through a
 library called [logr](https://github.com/go-logr/logr).  As we'll see shortly,
diff --git a/docs/book/src/cronjob-tutorial/testdata/emptymain.go b/docs/book/src/cronjob-tutorial/testdata/emptymain.go
@@ -18,7 +18,7 @@ limitations under the License.
 
 Our package starts out with some basic imports.  Particularly:
 
-- The core [controller-runtime](../TODO.md) library
+- The core [controller-runtime](https://godoc.org/sigs.k8s.io/controller-runtime) library
 - The default controller-runtime logging, Zap (more on that a bit later)
 
 */
@@ -37,9 +37,11 @@ import (
 )
 
 /*
-Every set of controllers needs a [*Scheme*](../TODO.md), which provides mappings
-between Kinds and their corresponding Go types.  We'll talk a bit more about Kinds
-when we write our API definition, so just keep this in mind for later.
+Every set of controllers needs a
+[*Scheme*](https://book.kubebuilder.io/cronjob-tutorial/gvks.html#err-but-whats-that-scheme-thing),
+which provides mappings between Kinds and their corresponding Go types.  We'll
+talk a bit more about Kinds when we write our API definition, so just keep this
+in mind for later.
 */
 var (
 	scheme   = runtime.NewScheme()
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go b/docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go
@@ -155,7 +155,8 @@ Some fields are declaratively validated by OpenAPI schema.
 You can find kubebuilder validation markers (prefixed
 with `// +kubebuilder:validation`) in the [API](api-design.md)
 You can find all of the kubebuilder supported markers for
-declaring validation in [here](../TODO.md).
+declaring validation by running `controller-gen crd -w`,
+or [here](../TODO.md).
 */
 
 func (r *CronJob) validateCronJobSpec() *field.Error {
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller.go b/docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller.go
@@ -109,10 +109,12 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 	/*
 	### 1: Load the CronJob by name
 
-	We'll fetch the CronJob using our client.  All client methods take a context
-	(to allow for cancellation) as their first argument, and the object in question
-	as their last.  Get is a bit special, in that it takes a [`NamespacedName`](../TODO.md)
-	as the middle argument (most don't have a middle argument, as we'll see below).
+	We'll fetch the CronJob using our client.  All client methods take a
+	context (to allow for cancellation) as their first argument, and the object
+	in question as their last.  Get is a bit special, in that it takes a
+	[`NamespacedName`](https://godoc.org/sigs.k8s.io/controller-runtime/pkg/client#ObjectKey)
+	as the middle argument (most don't have a middle argument, as we'll see
+	below).
 
 	Many client methods also take variadic options at the end.
 	*/
diff --git a/docs/book/src/quick-start.md b/docs/book/src/quick-start.md
@@ -66,10 +66,10 @@ kubebuilder create api --group webapp --version v1 --kind Guestbook
 This will create the files `api/v1/guestbook_types.go` and
 `controller/guestbook_controller.go` for you to edit.
 
-**Optional:** Edit the API definition or the reconciliation business logic.
-For more on this see [What is
-a Controller](cronjob-tutorial/controller-overview.html) and [What is
-a Resource](TODO.md)
+**Optional:** Edit the API definition or the reconciliation business
+logic. For more on this see [What's in
+a Controller](cronjob-tutorial/controller-overview.md) and [Designing an
+API](/cronjob-tutorial/api-design.md).
 
 ## Test It Out Locally
 
diff --git a/docs/book/src/reference/generating-crd.md b/docs/book/src/reference/generating-crd.md
@@ -1,4 +1,4 @@
-# Generating CRD
+# Generating CRDs
 
 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`. 
 
@@ -147,5 +147,4 @@ the following:
 
 - Set `CRD_OPTIONS ?= "crd:trivialVersions=false"` in the Makefile
 - Annotate the Go struct with marker `// +kubebuilder:storageversion` for the
-  indicating the storage version. Read [more](../TODO.md) for supporting
-  multiple versions in your project
+  indicating the storage version.
