Fixed doc generation (#864)

RedHatInsights · Sep 18, 2023 · 0064b90 · 0064b90
1 parent 4876d99
commit 0064b90
Show file tree

Hide file tree

Showing 5 changed files with 236 additions and 43 deletions.
diff --git a/build/build_api_docs.sh b/build/build_api_docs.sh
@@ -20,6 +20,6 @@ if ! command -v asciidoctor; then
 	exit 1
 fi
 
-docs/build/crd-ref-docs/crd-ref-docs --source-path=./apis --config=docs/build/crd-ref-docs/config.yaml \
+docs/build/crd-ref-docs/crd-ref-docs --source-path=./apis --config=docs/config.yaml \
 	--renderer=asciidoctor --templates-dir=docs/build/crd-ref-docs/templates/asciidoctor \
 	--output-path=docs/antora/modules/ROOT/pages/api_reference.adoc
diff --git a/config/crd/bases/cloud.redhat.com_clowdapps.yaml b/config/crd/bases/cloud.redhat.com_clowdapps.yaml
@@ -1064,7 +1064,7 @@ spec:
                                 in spec.resourceClaims, that are used by this container.
                                 \n This is an alpha field and requires enabling the
                                 DynamicResourceAllocation feature gate. \n This field
-                                is immutable."
+                                is immutable. It can only be set for containers."
                               items:
                                 description: ResourceClaim references one entry in
                                   PodSpec.ResourceClaims.
@@ -1794,7 +1794,8 @@ spec:
                                                   that are used by this container.
                                                   \n This is an alpha field and requires
                                                   enabling the DynamicResourceAllocation
-                                                  feature gate. \n This field is immutable."
+                                                  feature gate. \n This field is immutable.
+                                                  It can only be set for containers."
                                                 items:
                                                   description: ResourceClaim references
                                                     one entry in PodSpec.ResourceClaims.
@@ -3643,7 +3644,7 @@ spec:
                                 in spec.resourceClaims, that are used by this container.
                                 \n This is an alpha field and requires enabling the
                                 DynamicResourceAllocation feature gate. \n This field
-                                is immutable."
+                                is immutable. It can only be set for containers."
                               items:
                                 description: ResourceClaim references one entry in
                                   PodSpec.ResourceClaims.
@@ -4373,7 +4374,8 @@ spec:
                                                   that are used by this container.
                                                   \n This is an alpha field and requires
                                                   enabling the DynamicResourceAllocation
-                                                  feature gate. \n This field is immutable."
+                                                  feature gate. \n This field is immutable.
+                                                  It can only be set for containers."
                                                 items:
                                                   description: ResourceClaim references
                                                     one entry in PodSpec.ResourceClaims.

diff --git a/config/crd/bases/cloud.redhat.com_clowdenvironments.yaml b/config/crd/bases/cloud.redhat.com_clowdenvironments.yaml
@@ -522,7 +522,8 @@ spec:
                                   defined in spec.resourceClaims, that are used by
                                   this container. \n This is an alpha field and requires
                                   enabling the DynamicResourceAllocation feature gate.
-                                  \n This field is immutable."
+                                  \n This field is immutable. It can only be set for
+                                  containers."
                                 items:
                                   description: ResourceClaim references one entry
                                     in PodSpec.ResourceClaims.
@@ -589,7 +590,8 @@ spec:
                                           defined in spec.resourceClaims, that are
                                           used by this container. \n This is an alpha
                                           field and requires enabling the DynamicResourceAllocation
-                                          feature gate. \n This field is immutable."
+                                          feature gate. \n This field is immutable.
+                                          It can only be set for containers."
                                         items:
                                           description: ResourceClaim references one
                                             entry in PodSpec.ResourceClaims.
@@ -765,7 +767,8 @@ spec:
                     description: "Claims lists the names of resources, defined in
                       spec.resourceClaims, that are used by this container. \n This
                       is an alpha field and requires enabling the DynamicResourceAllocation
-                      feature gate. \n This field is immutable."
+                      feature gate. \n This field is immutable. It can only be set
+                      for containers."
                     items:
                       description: ResourceClaim references one entry in PodSpec.ResourceClaims.
                       properties: