Skip to content

Commit 1a90786

Browse files
author
Phillip Wittrock
authored
Merge pull request #133 from pwittrock/gitbook-original
GitBook add links to chapters
2 parents 158c292 + 1643bf1 commit 1a90786

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

docs/book/basics/project_creation_and_structure.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,9 @@ $ kubebuilder init --domain k8s.io
8080

8181
Create the *_types.go file and controller.go files.
8282

83+
For more on resources and controllers see [What Is A Resource](../basics/what_is_a_resource.md)
84+
and [What Is A Controller](../basics/what_is_a_controller.md)
85+
8386
{% sample lang="bash" %}
8487
```bash
8588
$ kubebuilder create resource --group mygroup --version v1beta1 --kind MyKind

docs/book/basics/running_tests.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ is created with `kubebuilder create resource`, a test file will be created to st
1515

1616
Update the test to include validation you add to your resource.
1717

18+
For more on Resources see [What Is A Resource](../basics/what_is_a_resource.md)
19+
20+
1821
#### Controller Tests
1922

2023
The controller tests are created under `pkg/controller/<kind>/controller_test.go`. When a resource
@@ -24,6 +27,8 @@ Reconcile function is called.
2427

2528
Update the test to verify the business logic of your controller.
2629

30+
For more on Controllers see [What Is A Controller](../basics/what_is_a_controller.md)
31+
2732
{% method %}
2833
## Run the tests
2934

docs/book/getting_started/hello_world.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ This book is being actively developed.
88
Kubernete APIs require boilerplate code that is not shown here and is managed by kubebuilder.
99

1010
Project structure may be created by running `kubebuilder init` and then creating a
11-
new API with `kubebuilder create resource`. More on this topic in *Project Creation and Structure*
11+
new API with `kubebuilder create resource`. More on this topic in
12+
[Project Creation and Structure](../basics/project_creation_and_structure.md)
1213
{% endpanel %}
1314

1415
This chapter shows an abridged Kubebuilder project for a simple API.
@@ -25,8 +26,12 @@ Kubernetes APIs have 3 components. These components live in separate go package
2526
This is a Resource definition. It is a go struct containing the API schema that
2627
implicitly defines CRUD endpoints for the Resource.
2728

29+
For a more information on Resources see [What is a Resource](../basics/what_is_a_resource.md).
30+
2831
While it is not shown here, most Resources will split their fields in into a Spec and a Status field.
2932

33+
For a more complete example see [Simple Resource Example](../basics/simple_resource.md)
34+
3035
{% sample lang="go" %}
3136
```go
3237
type Pancake struct {
@@ -52,7 +57,10 @@ mapped to the key of a Pancake object. This will trigger a full reconcile of
5257
the Pancake object, which will in turn read related cluster state, including the object the
5358
original event was for.
5459

55-
The code shown here has been abridged; for a more complete example see *Simple Controller Example*.
60+
For a more information on Controllers see [What is a Controller](../basics/what_is_a_controller.md).
61+
62+
The code shown here has been abridged; for a more complete example see
63+
[Simple Controller Example](../basics/simple_controller.md)
5664

5765
{% sample lang="go" %}
5866
```go

0 commit comments

Comments
 (0)