Skip to content

Commit d79cfa6

Browse files
authored
Merge pull request #4306 from vtrenton/make-generate-fix
📖 (doc): getting started: fix information about make command for generating manifests
2 parents f3a65b6 + c372328 commit d79cfa6

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/book/src/getting-started.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,15 @@ Now, see our example fully completed.
125125

126126
#### Generating manifests with the specs and validations
127127

128-
To generate the required CRDs we will run `make generate` command, which will call [controller-gen][controller-gen]
129-
to generate the CRD manifest, which is located under the `config/crd/bases` directory.
128+
To generate all required files:
130129

131-
<details><summary><code>config/crd/bases/cache.example.com_memcacheds.yam</code>: Our Memcached CRD</summary>
130+
1. Run `make generate` to create the DeepCopy implementations in `api/v1alpha1/zz_generated.deepcopy.go`.
131+
132+
2. Then, run `make manifests` to generate the CRD manifests under `config/crd/bases` and a sample for it under `config/crd/samples`.
133+
134+
Both commands use [controller-gen][controller-gen] with different flags for code and manifest generation, respectively.
135+
136+
<details><summary><code>config/crd/bases/cache.example.com_memcacheds.yaml</code>: Our Memcached CRD</summary>
132137

133138
```yaml
134139
{{#include ./getting-started/testdata/project/config/crd/bases/cache.example.com_memcacheds.yaml}}

0 commit comments

Comments
 (0)