Address remaining PR comments

- Revert to CronJob example to maintain consistency with existing demos
- Make generate-demo.sh flexible to support multiple demo variations
- Add support for custom demo names and scripts via CLI parameters
- Only update README for default kb-demo, not custom demos
- Add usage/help documentation for the script

This addresses feedback from camilamacedo86 on PR #5068:
1. Keep the same example (CronJob instead of Guestbook/Busybox)
2. Allow script to generate other demos for future extensibility

Author: wazery

scripts/demo/README.md

@@ -29,6 +29,26 @@ This will:
 5. Update the demo file in `docs/gif/kb-demo.${VERSION}.svg`
 6. Clean up temporary files
 
+### Generate Custom Demos
+
+The script supports generating multiple demo variations:
+
+```sh
+# Generate the default kb-demo
+./scripts/demo/generate-demo.sh
+
+# Generate a custom demo with a different name
+./scripts/demo/generate-demo.sh my-custom-demo
+
+# Generate a custom demo using a different script
+./scripts/demo/generate-demo.sh advanced-demo ./path/to/custom-script.sh
+
+# Show help
+./scripts/demo/generate-demo.sh --help
+```
+
+Custom demos will be saved to `docs/gif/${DEMO_NAME}.${VERSION}.svg` and won't automatically update the README (you'll need to reference them manually).
+
 ## Setup Demo Cluster Only
 
 If you just want to set up the Kind cluster for testing:

scripts/demo/generate-demo.sh

@@ -19,6 +19,10 @@ set -e
 SCRIPT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 PROJECT_ROOT="$(cd "${SCRIPT_ROOT}/../.." && pwd)"
 
+# Default demo name
+DEMO_NAME="${1:-kb-demo}"
+DEMO_SCRIPT="${2:-${SCRIPT_ROOT}/run.sh}"
+
 # Colors for output
 RED='\033[0;31m'
 GREEN='\033[0;32m'
@@ -38,9 +42,38 @@ error() {
     exit 1
 }
 
+usage() {
+    cat << EOF
+Usage: $0 [DEMO_NAME] [DEMO_SCRIPT]
+
+Generate an asciinema demo recording and convert it to SVG.
+
+Arguments:
+    DEMO_NAME     Name of the demo (default: kb-demo)
+    DEMO_SCRIPT   Path to the demo script to run (default: ${SCRIPT_ROOT}/run.sh)
+
+Examples:
+    $0                              # Generate default kb-demo
+    $0 my-custom-demo               # Generate custom demo with default script
+    $0 advanced-demo ./my-demo.sh   # Generate custom demo with custom script
+
+EOF
+    exit 0
+}
+
 check_prerequisites() {
     log "Checking prerequisites..."
 
+    # Check for help flag
+    if [[ "$1" == "-h" || "$1" == "--help" ]]; then
+        usage
+    fi
+    
+    # Validate demo script exists
+    if [[ ! -f "$DEMO_SCRIPT" ]]; then
+        error "Demo script not found: $DEMO_SCRIPT"
+    fi
+    
     local missing_tools=()
 
     if ! command -v asciinema &> /dev/null; then
@@ -82,38 +115,44 @@ record_demo() {
     rm -rf "$recording_dir"
     mkdir -p "$recording_dir"
 
-    log "Starting demo recording in 3 seconds..."
+    log "Starting demo recording for '${DEMO_NAME}' in 3 seconds..."
     sleep 3
 
     cd "$recording_dir"
     asciinema rec \
-        --command "${SCRIPT_ROOT}/run.sh" \
+        --command "$DEMO_SCRIPT" \
         --env "DEMO_AUTO_RUN=1" \
-        --title "Kubebuilder Demo" \
+        --title "Kubebuilder Demo: ${DEMO_NAME}" \
         --idle-time-limit 2 \
-        kb-demo.cast
+        "${DEMO_NAME}.cast"
 }
 
 convert_to_svg() {
     local recording_dir="/tmp/kb-demo-recording"
     local version="$1"
-    local svg_file="${PROJECT_ROOT}/docs/gif/kb-demo.${version}.svg"
+    local svg_file="${PROJECT_ROOT}/docs/gif/${DEMO_NAME}.${version}.svg"
 
     log "Converting recording to SVG..."
     svg-term \
-        --in="${recording_dir}/kb-demo.cast" \
+        --in="${recording_dir}/${DEMO_NAME}.cast" \
         --out="$svg_file" \
         --window \
         --width=120 \
         --height=30
 
-    log "Demo updated! New file: docs/gif/kb-demo.${version}.svg"
+    log "Demo updated! New file: docs/gif/${DEMO_NAME}.${version}.svg"
     return 0
 }
 
 update_readme() {
     local version="$1"
 
+    # Only update README for the default kb-demo
+    if [[ "$DEMO_NAME" != "kb-demo" ]]; then
+        log "Skipping README update for custom demo '${DEMO_NAME}'"
+        return 0
+    fi
+    
     log "Updating README.md with new demo..."
     if [[ "$OSTYPE" == "darwin"* ]]; then
         # macOS
@@ -133,7 +172,13 @@ cleanup() {
 }
 
 main() {
-    log "Starting Kubebuilder demo generation..."
+    # Check for help flag first
+    if [[ "$1" == "-h" || "$1" == "--help" ]]; then
+        usage
+    fi
+    
+    log "Starting Kubebuilder demo generation for '${DEMO_NAME}'..."
+    log "Using demo script: ${DEMO_SCRIPT}"
 
     # Extract version once to avoid duplication
     local version
@@ -147,6 +192,7 @@ main() {
     cleanup
 
     log "Demo generation completed successfully! 🎉"
+    log "Generated: docs/gif/${DEMO_NAME}.${version}.svg"
 }
 
 main "$@"

scripts/demo/run.sh

@@ -22,63 +22,28 @@ cd kubebuilder-demo-project
 clear
 . $(dirname ${BASH_SOURCE})/util.sh
 
-desc "Check if Kubebuilder is installed"
-run "kubebuilder version"
+desc "Initialize Go modules"
+run "go mod init demo.kubebuilder.io"
 
-desc "Initialize Go modules for our project"
-run "go mod init demo.kubebuilder.io/webapp-operator"
-
-desc "Initialize a new Kubebuilder project with custom domain"
-run "kubebuilder init --domain demo.kubebuilder.io --repo demo.kubebuilder.io/webapp-operator"
-clear
-
-desc "Examine the scaffolded project structure"
-run "tree -L 2 ."
-clear
-
-desc "Create our first API - a Guestbook with validation markers"
-run "kubebuilder create api --group webapp --version v1 --kind Guestbook"
-clear
-
-desc "Let's explore the generated files structure"
-run "tree api/ internal/controller/"
+desc "Let's initialize the project"
+run "kubebuilder init --domain tutorial.kubebuilder.io"
 clear
 
-desc "Look at the API definition - notice the validation markers"
-run "cat api/v1/guestbook_types.go"
+desc "Examine scaffolded files..."
+run "tree ."
 clear
 
-desc "Now let's create a second API using the modern deploy-image plugin"
-run "kubebuilder create api --group webapp --version v1alpha1 --kind Busybox --image=busybox:1.36.1 --plugins=deploy-image/v1-alpha"
+desc "Create our custom cronjob api"
+run "kubebuilder create api --group batch --version v1 --kind CronJob"
 clear
 
-desc "Generate manifests including CRDs with OpenAPI validation schemas"
-run "make manifests"
-
-desc "Examine the generated CRD with validation rules"
-run "head -60 config/crd/bases/webapp.demo.kubebuilder.io_guestbooks.yaml"
+desc "Let's take a look at the API and Controller files"
+run "tree ./api ./internal/controller"
 clear
 
-desc "Install our Custom Resource Definitions into the cluster"
+desc "Install CRDs in Kubernetes cluster"
 run "make install"
-
-desc "Verify our CRDs are installed"
-run "kubectl get crd --context kind-kubebuilder-demo"
-clear
-
-desc "Look at the sample resources that were generated"
-run "ls config/samples/"
-
-desc "Show a sample resource"
-run "cat config/samples/webapp_v1_guestbook.yaml"
-clear
-
-desc "Apply the sample resources to test our APIs"
-run "kubectl apply -f config/samples/webapp_v1alpha1_busybox.yaml --context kind-kubebuilder-demo"
-
-desc "Check the created custom resources in the cluster"
-run "kubectl get guestbooks,busyboxes -A --context kind-kubebuilder-demo"
 clear
 
-desc "Demo completed! The controller can be run with 'make run'"
-run "echo 'To run the controller: make run'"
+desc "Run controller manager locally"
+run "make run"