Skip to content

Commit

Permalink
Updated formating and referenced created samples
Browse files Browse the repository at this point in the history
  • Loading branch information
vtrenton authored Nov 8, 2024
1 parent 98c9372 commit 98ac79d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/book/src/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,13 @@ Now, see our example fully completed.

#### Generating manifests with the specs and validations

To generate all required files, run `make generate` to create the DeepCopy implementations in `api/v1alpha1/zz_generated.deepcopy.go`, followed by `make manifests` to generate the CRD manifests under `config/crd/bases`. Both commands use [controller-gen][controller-gen] with different flags for code and manifest generation respectively.
To generate all required files:

1. Run `make generate` to create the DeepCopy implementations in `api/v1alpha1/zz_generated.deepcopy.go`.

2. Then, run `make manifests` to generate the CRD manifests under `config/crd/bases` and a sample for it under `config/crd/samples`.

Both commands use [controller-gen][controller-gen] with different flags for code and manifest generation, respectively.

<details><summary><code>config/crd/bases/cache.example.com_memcacheds.yaml</code>: Our Memcached CRD</summary>

Expand Down

0 comments on commit 98ac79d

Please sign in to comment.