From c372328d3c43e5d811b8d1d646b18ca9a7a48b9f Mon Sep 17 00:00:00 2001 From: "Trent V." Date: Fri, 8 Nov 2024 11:58:04 -0600 Subject: [PATCH] clearified instructions on make command for manifests --- docs/book/src/getting-started.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/book/src/getting-started.md b/docs/book/src/getting-started.md index 5c9a88cb7a1..569eee62a8d 100644 --- a/docs/book/src/getting-started.md +++ b/docs/book/src/getting-started.md @@ -125,10 +125,15 @@ Now, see our example fully completed. #### Generating manifests with the specs and validations -To generate the required CRDs we will run `make generate` command, which will call [controller-gen][controller-gen] -to generate the CRD manifest, which is located under the `config/crd/bases` directory. +To generate all required files: -
config/crd/bases/cache.example.com_memcacheds.yam: Our Memcached CRD +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. + +
config/crd/bases/cache.example.com_memcacheds.yaml: Our Memcached CRD ```yaml {{#include ./getting-started/testdata/project/config/crd/bases/cache.example.com_memcacheds.yaml}}