modify scripts to generate API docs

Signed-off-by: Meg McRoberts <[email protected]>
keptn · Mar 29, 2023 · ee060e2 · ee060e2
1 parent 5f77bf6
commit ee060e2
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 7 deletions.
diff --git a/.github/scripts/generate-crd-docs/generate-crd-docs.sh b/.github/scripts/generate-crd-docs/generate-crd-docs.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# CRD docs auto generation script
+# API docs auto generation script
 #
 # This script goes through all API definitions in the operator/apis folder
 # and generates docs from code for each API group and version
@@ -18,7 +18,7 @@ RENDERER_CONFIG_FILE='.github/scripts/generate-crd-docs/crd-docs-generator-confi
 echo "Checking if code generator tool is installed..."
 test -s api-ref-docs || go install github.com/elastic/api-ref-docs@${GENERATOR_VERSION}
 
-echo "Running CRD docs auto-generator..."
+echo "Running API docs auto-generator..."
 
 for api_group in "$API_ROOT"*; do
   sanitized_api_group="${api_group#$API_ROOT}"
@@ -50,7 +50,7 @@ for api_group in "$API_ROOT"*; do
     echo "Creating docs folder $OUTPUT_PATH..."
     mkdir -p "$OUTPUT_PATH"
 
-    echo "Generating CRD docs for $sanitized_api_group.$API_DOMAIN/$sanitized_api_version..."
+    echo "Generating API docs for $sanitized_api_group.$API_DOMAIN/$sanitized_api_version..."
     api-ref-docs \
       --templates-dir "$TEMPLATE_DIR" \
       --source-path="./$api_version" \

diff --git a/docs/content/en/docs/crd-ref/lifecycle/_index.md b/docs/content/en/docs/crd-ref/lifecycle/_index.md