chore: hide unused KeptnEvaluationProvider from the crd docs (#2146)

Signed-off-by: realanna <anna.reale@dynatrace.com>
keptn · Sep 21, 2023 · d2743bf · d2743bf
1 parent 2252b2d
commit d2743bf
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 147 deletions.
diff --git a/.github/scripts/generate-crd-docs/crd-docs-generator-config.yaml b/.github/scripts/generate-crd-docs/crd-docs-generator-config.yaml
@@ -2,6 +2,8 @@ processor:
   useRawDocstring: true
   ignoreTypes:
     - "EmptyStatus$"
+    - "KeptnEvaluationProvider$"
+    - "KeptnEvaluationProviderList$"
   ignoreFields:
     - "TypeMeta$"
     - "EmptyStatus$"

diff --git a/docs/content/en/docs/crd-ref/lifecycle/v1alpha1/_index.md b/docs/content/en/docs/crd-ref/lifecycle/v1alpha1/_index.md
@@ -21,8 +21,6 @@ Package v1alpha1 contains API Schema definitions for the lifecycle v1alpha1 API
 - [KeptnEvaluationDefinition](#keptnevaluationdefinition)
 - [KeptnEvaluationDefinitionList](#keptnevaluationdefinitionlist)
 - [KeptnEvaluationList](#keptnevaluationlist)
-- [KeptnEvaluationProvider](#keptnevaluationprovider)
-- [KeptnEvaluationProviderList](#keptnevaluationproviderlist)
 - [KeptnTask](#keptntask)
 - [KeptnTaskDefinition](#keptntaskdefinition)
 - [KeptnTaskDefinitionList](#keptntaskdefinitionlist)
@@ -395,53 +393,6 @@ KeptnEvaluationList contains a list of KeptnEvaluation
 | `items` _[KeptnEvaluation](#keptnevaluation) array_ |  |
 
 
-#### KeptnEvaluationProvider
-
-
-
-KeptnEvaluationProvider is the Schema for the keptnevaluationproviders API
-
-_Appears in:_
-- [KeptnEvaluationProviderList](#keptnevaluationproviderlist)
-
-| Field | Description |
-| --- | --- |
-| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1`
-| `kind` _string_ | `KeptnEvaluationProvider`
-| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
-| `spec` _[KeptnEvaluationProviderSpec](#keptnevaluationproviderspec)_ |  |
-| `status` _string_ | unused field |
-
-
-#### KeptnEvaluationProviderList
-
-
-
-KeptnEvaluationProviderList contains a list of KeptnEvaluationProvider
-
-
-
-| Field | Description |
-| --- | --- |
-| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1`
-| `kind` _string_ | `KeptnEvaluationProviderList`
-| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
-| `items` _[KeptnEvaluationProvider](#keptnevaluationprovider) array_ |  |
-
-
-#### KeptnEvaluationProviderSpec
-
-
-
-KeptnEvaluationProviderSpec defines the desired state of KeptnEvaluationProvider
-
-_Appears in:_
-- [KeptnEvaluationProvider](#keptnevaluationprovider)
-
-| Field | Description |
-| --- | --- |
-| `targetServer` _string_ |  |
-| `secretName` _string_ |  |
 
 
 #### KeptnEvaluationSpec

diff --git a/docs/content/en/docs/crd-ref/lifecycle/v1alpha2/_index.md b/docs/content/en/docs/crd-ref/lifecycle/v1alpha2/_index.md
@@ -21,8 +21,6 @@ Package v1alpha2 contains API Schema definitions for the lifecycle v1alpha2 API
 - [KeptnEvaluationDefinition](#keptnevaluationdefinition)
 - [KeptnEvaluationDefinitionList](#keptnevaluationdefinitionlist)
 - [KeptnEvaluationList](#keptnevaluationlist)
-- [KeptnEvaluationProvider](#keptnevaluationprovider)
-- [KeptnEvaluationProviderList](#keptnevaluationproviderlist)
 - [KeptnTask](#keptntask)
 - [KeptnTaskDefinition](#keptntaskdefinition)
 - [KeptnTaskDefinitionList](#keptntaskdefinitionlist)
@@ -397,53 +395,6 @@ KeptnEvaluationList contains a list of KeptnEvaluation
 | `items` _[KeptnEvaluation](#keptnevaluation) array_ |  |
 
 
-#### KeptnEvaluationProvider
-
-
-
-KeptnEvaluationProvider is the Schema for the keptnevaluationproviders API
-
-_Appears in:_
-- [KeptnEvaluationProviderList](#keptnevaluationproviderlist)
-
-| Field | Description |
-| --- | --- |
-| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2`
-| `kind` _string_ | `KeptnEvaluationProvider`
-| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
-| `spec` _[KeptnEvaluationProviderSpec](#keptnevaluationproviderspec)_ |  |
-| `status` _string_ | unused field |
-
-
-#### KeptnEvaluationProviderList
-
-
-
-KeptnEvaluationProviderList contains a list of KeptnEvaluationProvider
-
-
-
-| Field | Description |
-| --- | --- |
-| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha2`
-| `kind` _string_ | `KeptnEvaluationProviderList`
-| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
-| `items` _[KeptnEvaluationProvider](#keptnevaluationprovider) array_ |  |
-
-
-#### KeptnEvaluationProviderSpec
-
-
-
-KeptnEvaluationProviderSpec defines the desired state of KeptnEvaluationProvider
-
-_Appears in:_
-- [KeptnEvaluationProvider](#keptnevaluationprovider)
-
-| Field | Description |
-| --- | --- |
-| `targetServer` _string_ |  |
-| `secretKeyRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#secretkeyselector-v1-core)_ |  |
 
 
 #### KeptnEvaluationSpec

diff --git a/docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md b/docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md
@@ -23,8 +23,6 @@ Package v1alpha3 contains API Schema definitions for the lifecycle v1alpha3 API
 - [KeptnEvaluationDefinition](#keptnevaluationdefinition)
 - [KeptnEvaluationDefinitionList](#keptnevaluationdefinitionlist)
 - [KeptnEvaluationList](#keptnevaluationlist)
-- [KeptnEvaluationProvider](#keptnevaluationprovider)
-- [KeptnEvaluationProviderList](#keptnevaluationproviderlist)
 - [KeptnTask](#keptntask)
 - [KeptnTaskDefinition](#keptntaskdefinition)
 - [KeptnTaskDefinitionList](#keptntaskdefinitionlist)
@@ -462,53 +460,6 @@ KeptnEvaluationList contains a list of KeptnEvaluation
 | `items` _[KeptnEvaluation](#keptnevaluation) array_ |  |
 
 
-#### KeptnEvaluationProvider
-
-
-
-KeptnEvaluationProvider is the Schema for the keptnevaluationproviders API
-
-_Appears in:_
-- [KeptnEvaluationProviderList](#keptnevaluationproviderlist)
-
-| Field | Description |
-| --- | --- |
-| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha3`
-| `kind` _string_ | `KeptnEvaluationProvider`
-| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
-| `spec` _[KeptnEvaluationProviderSpec](#keptnevaluationproviderspec)_ |  |
-| `status` _string_ | unused field |
-
-
-#### KeptnEvaluationProviderList
-
-
-
-KeptnEvaluationProviderList contains a list of KeptnEvaluationProvider
-
-
-
-| Field | Description |
-| --- | --- |
-| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha3`
-| `kind` _string_ | `KeptnEvaluationProviderList`
-| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
-| `items` _[KeptnEvaluationProvider](#keptnevaluationprovider) array_ |  |
-
-
-#### KeptnEvaluationProviderSpec
-
-
-
-KeptnEvaluationProviderSpec defines the desired state of KeptnEvaluationProvider
-
-_Appears in:_
-- [KeptnEvaluationProvider](#keptnevaluationprovider)
-
-| Field | Description |
-| --- | --- |
-| `targetServer` _string_ |  |
-| `secretKeyRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#secretkeyselector-v1-core)_ |  |
 
 
 #### KeptnEvaluationSpec