docs: fix generation of underlying types

Signed-off-by: RealAnna <[email protected]>
keptn · Feb 29, 2024 · b2c5bfa · b2c5bfa
1 parent c996315
commit b2c5bfa
Show file tree

Hide file tree

Showing 9 changed files with 166 additions and 101 deletions.
diff --git a/.github/scripts/generate-crd-docs/templates/type.tpl b/.github/scripts/generate-crd-docs/templates/type.tpl
@@ -24,7 +24,7 @@ _Appears in:_
 {{ end -}}
 
 {{ range $type.Members -}}
-| `{{ .Name }}` {{ if .Type.IsAlias }}_{{  markdownRenderTypeLink .Type.UnderlyingType  }}_{{else}}_{{ markdownRenderType .Type }}_{{ end }} | {{ template "type_members" . }} |
+| `{{ .Name  }}` _{{ markdownRenderType .Type }}_ | {{ template "type_members" . }} |
 {{- if index .Markers "kubebuilder:default" -}}
 {{- with index (index .Markers "kubebuilder:default") 0 -}}
  {{ .Value -}}

diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md
@@ -61,7 +61,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `evaluationDefinitionName` _string_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `evaluationName` _string_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
@@ -79,7 +79,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `value` _string_ |  || x |
-| `status` _string_ |  || x |
+| `status` _[KeptnState](#keptnstate)_ |  || x |
 | `message` _string_ |  || ✓ |
 
 
@@ -293,19 +293,19 @@ _Appears in:_
 
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
-| `preDeploymentStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentStatus` _string_ |  |Pending| ✓ |
-| `preDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `workloadOverallStatus` _string_ |  |Pending| ✓ |
+| `preDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `preDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `workloadOverallStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `workloadStatus` _[WorkloadStatus](#workloadstatus) array_ |  || ✓ |
 | `currentPhase` _string_ |  || ✓ |
 | `preDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `postDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `preDeploymentEvaluationTaskStatus` _[EvaluationStatus](#evaluationstatus) array_ |  || ✓ |
 | `postDeploymentEvaluationTaskStatus` _[EvaluationStatus](#evaluationstatus) array_ |  || ✓ |
-| `phaseTraceIDs` _[MapCarrier](https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier)_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ |  || ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 
@@ -414,7 +414,7 @@ _Appears in:_
 | `retries` _integer_ |  |10| ✓ |
 | `retryInterval` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#duration-v1-meta)_ |  |5s| ✓ |
 | `failAction` _string_ |  || ✓ |
-| `checkType` _string_ |  || ✓ |
+| `checkType` _[CheckType](#checktype)_ |  || ✓ |
 
 
 #### KeptnEvaluationStatus
@@ -430,7 +430,7 @@ _Appears in:_
 | --- | --- | --- | --- |
 | `retryCount` _integer_ |  |0| x |
 | `evaluationStatus` _object (keys:string, values:[EvaluationStatusItem](#evaluationstatusitem))_ |  || x |
-| `overallStatus` _string_ |  |Pending| x |
+| `overallStatus` _[KeptnState](#keptnstate)_ |  |Pending| x |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 
@@ -550,7 +550,7 @@ _Appears in:_
 | `context` _[TaskContext](#taskcontext)_ |  || x |
 | `parameters` _[TaskParameters](#taskparameters)_ |  || ✓ |
 | `secureParameters` _[SecureParameters](#secureparameters)_ |  || ✓ |
-| `checkType` _string_ |  || ✓ |
+| `checkType` _[CheckType](#checktype)_ |  || ✓ |
 
 
 #### KeptnTaskStatus
@@ -565,7 +565,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `jobName` _string_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `message` _string_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
@@ -657,20 +657,20 @@ _Appears in:_
 
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
-| `preDeploymentStatus` _string_ |  |Pending| ✓ |
-| `deploymentStatus` _string_ |  |Pending| ✓ |
-| `preDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentStatus` _string_ |  |Pending| ✓ |
+| `preDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `deploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `preDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `preDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `postDeploymentTaskStatus` _[TaskStatus](#taskstatus) array_ |  || ✓ |
 | `preDeploymentEvaluationTaskStatus` _[EvaluationStatus](#evaluationstatus) array_ |  || ✓ |
 | `postDeploymentEvaluationTaskStatus` _[EvaluationStatus](#evaluationstatus) array_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `currentPhase` _string_ |  || ✓ |
-| `phaseTraceIDs` _[MapCarrier](https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier)_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ |  || ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 
 
 #### KeptnWorkloadList
@@ -769,7 +769,7 @@ _Appears in:_
 
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
-| `uid` _string_ |  || x |
+| `uid` _[UID](#uid)_ |  || x |
 | `kind` _string_ |  || x |
 | `name` _string_ |  || x |
 
@@ -836,7 +836,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `taskDefinitionName` _string_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `taskName` _string_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
@@ -854,6 +854,6 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `workload` _[KeptnWorkloadRef](#keptnworkloadref)_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 
 
diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha2/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha2/index.md
@@ -60,7 +60,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `value` _string_ |  || x |
-| `status` _string_ |  || x |
+| `status` _[KeptnState](#keptnstate)_ |  || x |
 | `message` _string_ |  || ✓ |
 
 
@@ -152,7 +152,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `definitionName` _string_ | DefinitionName is the name of the EvaluationDefinition/TaskDefinition || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `name` _string_ | Name is the name of the Evaluation/Task || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
@@ -295,19 +295,19 @@ _Appears in:_
 
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
-| `preDeploymentStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentStatus` _string_ |  |Pending| ✓ |
-| `preDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `workloadOverallStatus` _string_ |  |Pending| ✓ |
+| `preDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `preDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `workloadOverallStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `workloadStatus` _[WorkloadStatus](#workloadstatus) array_ |  || ✓ |
 | `currentPhase` _string_ |  || ✓ |
 | `preDeploymentTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
 | `postDeploymentTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
 | `preDeploymentEvaluationTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
 | `postDeploymentEvaluationTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
-| `phaseTraceIDs` _[MapCarrier](https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier)_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ |  || ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 
@@ -416,7 +416,7 @@ _Appears in:_
 | `retries` _integer_ |  |10| ✓ |
 | `retryInterval` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#duration-v1-meta)_ |  |5s| ✓ |
 | `failAction` _string_ |  || ✓ |
-| `checkType` _string_ |  || ✓ |
+| `checkType` _[CheckType](#checktype)_ |  || ✓ |
 
 
 #### KeptnEvaluationStatus
@@ -432,7 +432,7 @@ _Appears in:_
 | --- | --- | --- | --- |
 | `retryCount` _integer_ |  |0| x |
 | `evaluationStatus` _object (keys:string, values:[EvaluationStatusItem](#evaluationstatusitem))_ |  || x |
-| `overallStatus` _string_ |  |Pending| x |
+| `overallStatus` _[KeptnState](#keptnstate)_ |  |Pending| x |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 
@@ -552,7 +552,7 @@ _Appears in:_
 | `context` _[TaskContext](#taskcontext)_ |  || x |
 | `parameters` _[TaskParameters](#taskparameters)_ |  || ✓ |
 | `secureParameters` _[SecureParameters](#secureparameters)_ |  || ✓ |
-| `checkType` _string_ |  || ✓ |
+| `checkType` _[CheckType](#checktype)_ |  || ✓ |
 
 
 #### KeptnTaskStatus
@@ -567,7 +567,7 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `jobName` _string_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `message` _string_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
@@ -659,20 +659,20 @@ _Appears in:_
 
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
-| `preDeploymentStatus` _string_ |  |Pending| ✓ |
-| `deploymentStatus` _string_ |  |Pending| ✓ |
-| `preDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentEvaluationStatus` _string_ |  |Pending| ✓ |
-| `postDeploymentStatus` _string_ |  |Pending| ✓ |
+| `preDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `deploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `preDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentEvaluationStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
+| `postDeploymentStatus` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 | `preDeploymentTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
 | `postDeploymentTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
 | `preDeploymentEvaluationTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
 | `postDeploymentEvaluationTaskStatus` _[ItemStatus](#itemstatus) array_ |  || ✓ |
 | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#time-v1-meta)_ |  || ✓ |
 | `currentPhase` _string_ |  || ✓ |
-| `phaseTraceIDs` _[MapCarrier](https://pkg.go.dev/go.opentelemetry.io/otel/propagation#MapCarrier)_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `phaseTraceIDs` _[PhaseTraceID](#phasetraceid)_ |  || ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |
 
 
 #### KeptnWorkloadList
@@ -771,7 +771,7 @@ _Appears in:_
 
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
-| `uid` _string_ |  || x |
+| `uid` _[UID](#uid)_ |  || x |
 | `kind` _string_ |  || x |
 | `name` _string_ |  || x |
 
@@ -837,6 +837,6 @@ _Appears in:_
 | Field | Description | Default | Optional |
 | --- | --- | --- | --- |
 | `workload` _[KeptnWorkloadRef](#keptnworkloadref)_ |  || ✓ |
-| `status` _string_ |  |Pending| ✓ |
+| `status` _[KeptnState](#keptnstate)_ |  |Pending| ✓ |