add docs comment to script

Signed-off-by: Moritz Wiesinger <[email protected]>
keptn · Feb 21, 2023 · f750d51 · f750d51
1 parent 78a3864
commit f750d51
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/.github/scripts/generate-crd-docs/generate-crd-docs.sh b/.github/scripts/generate-crd-docs/generate-crd-docs.sh
@@ -1,4 +1,12 @@
 #!/bin/bash
+
+# CRD 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
+#
+# Inputs: None
+
 # renovate: datasource=github-releases depName=elastic/crd-ref-docs
 GENERATOR_VERSION=v0.0.8
 API_DOMAIN="keptn.sh"