Skip to content

Commit 4c0b8d6

Browse files
authored
Merge pull request #4609 from mo3et/fix/err-type
📖 docs: fix incorrect json tag in API example.
2 parents e15c921 + 9925896 commit 4c0b8d6

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/book/src/quick-start.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ Read the [Go modules blogpost][go-modules-blogpost] if unfamiliar with the modul
6666

6767
</aside>
6868

69-
7069
## Create an API
7170

7271
Run the following command to create a new API (group/version) as `webapp/v1` and the new Kind(CRD) `Guestbook` on it:
@@ -83,12 +82,12 @@ and the `internal/controllers/guestbook_controller.go` where the reconciliation
8382

8483
</aside>
8584

86-
8785
**OPTIONAL:** Edit the API definition and the reconciliation business
8886
logic. For more info see [Designing an API](/cronjob-tutorial/api-design.md) and [What's in
8987
a Controller](cronjob-tutorial/controller-overview.md).
9088

9189
If you are editing the API definitions, generate the manifests such as Custom Resources (CRs) or Custom Resource Definitions (CRDs) using
90+
9291
```bash
9392
make manifests
9493
```
@@ -113,7 +112,7 @@ type GuestbookSpec struct {
113112
ConfigMapName string `json:"configMapName"`
114113

115114
// +kubebuilder:validation:Enum=Phone;Address;Name
116-
Type string `json:"alias,omitempty"`
115+
Type string `json:"type,omitempty"`
117116
}
118117

119118
// GuestbookStatus defines the observed state of Guestbook
@@ -145,10 +144,9 @@ type Guestbook struct {
145144
</p>
146145
</details>
147146

148-
149147
## Test It Out
150148

151-
You'll need a Kubernetes cluster to run against. You can use
149+
You'll need a Kubernetes cluster to run against. You can use
152150
[KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or
153151
run against a remote cluster.
154152

@@ -161,12 +159,14 @@ kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
161159
</aside>
162160

163161
Install the CRDs into the cluster:
162+
164163
```bash
165164
make install
166165
```
167166

168167
For quick feedback and code-level debugging, run your controller (this will run in the foreground, so switch to a new
169168
terminal if you want to leave it running):
169+
170170
```bash
171171
make run
172172
```
@@ -181,6 +181,7 @@ kubectl apply -k config/samples/
181181
```
182182

183183
## Run It On the Cluster
184+
184185
When your controller is ready to be packaged and tested in other clusters.
185186

186187
Build and push your image to the location specified by `IMG`:
@@ -238,8 +239,8 @@ make undeploy
238239

239240
- Now, take a look at the [Architecture Concept Diagram][architecture-concept-diagram] for a clearer overview.
240241
- Next, proceed with the [Getting Started Guide][getting-started], which should take no more than 30 minutes and will
241-
provide a solid foundation. Afterward, dive into the [CronJob Tutorial][cronjob-tutorial] to deepen your
242-
understanding by developing a demo project.
242+
provide a solid foundation. Afterward, dive into the [CronJob Tutorial][cronjob-tutorial] to deepen your
243+
understanding by developing a demo project.
243244

244245
[pre-rbc-gke]: https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control#iam-rolebinding-bootstrap
245246
[cronjob-tutorial]: https://book.kubebuilder.io/cronjob-tutorial/cronjob-tutorial.html

0 commit comments

Comments
 (0)