From 17108bb260b51dd99bf136b0931cf973ce90b464 Mon Sep 17 00:00:00 2001 From: letthefireflieslive Date: Mon, 19 Feb 2024 20:41:03 +0800 Subject: [PATCH] Specify what is run and deployed Briefly explain what is run and why it's `make run` at first and explain why the controller is deployed in the latter Update docs/book/src/quick-start.md Co-authored-by: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> --- docs/book/src/quick-start.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/book/src/quick-start.md b/docs/book/src/quick-start.md index e1cc22c8db..2abb74fab1 100644 --- a/docs/book/src/quick-start.md +++ b/docs/book/src/quick-start.md @@ -168,7 +168,7 @@ Install the CRDs into the cluster: make install ``` -Run your controller (this will run in the foreground, so switch to a new +For quick feedback and code-level debugging, run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running): ```bash make run @@ -184,6 +184,7 @@ kubectl apply -k config/samples/ ``` ## Run It On the Cluster +When your controller is ready to be packaged and tested in other clusters. Build and push your image to the location specified by `IMG`: