From 4e9daa772aec98e27ce3a195c825c6075e6bf411 Mon Sep 17 00:00:00 2001 From: RealAnna Date: Thu, 29 Feb 2024 14:10:54 +0100 Subject: [PATCH] docs: add missing go docs in phases Signed-off-by: RealAnna --- docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md | 2 +- docs/docs/reference/api-reference/lifecycle/v1alpha2/index.md | 2 +- docs/docs/reference/api-reference/lifecycle/v1alpha3/index.md | 2 +- docs/docs/reference/api-reference/lifecycle/v1beta1/index.md | 2 +- lifecycle-operator/apis/lifecycle/v1alpha1/common/phases.go | 2 ++ lifecycle-operator/apis/lifecycle/v1alpha2/common/phases.go | 2 ++ lifecycle-operator/apis/lifecycle/v1alpha3/common/phases.go | 2 ++ lifecycle-operator/apis/lifecycle/v1beta1/common/phases.go | 2 ++ 8 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md index f04726d1173..ae3473a9f29 100644 --- a/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md +++ b/docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md @@ -459,7 +459,7 @@ _Appears in:_ - +KeptnPhaseType holds long and short names of each phase supported by Keptn _Appears in:_ - [KeptnPhase](#keptnphase) diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha2/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha2/index.md index 3753a05e120..4e5ecdfc6bd 100644 --- a/docs/docs/reference/api-reference/lifecycle/v1alpha2/index.md +++ b/docs/docs/reference/api-reference/lifecycle/v1alpha2/index.md @@ -457,7 +457,7 @@ _Appears in:_ - +KeptnPhaseType holds long and short names of each phase supported by Keptn _Appears in:_ - [KeptnPhase](#keptnphase) diff --git a/docs/docs/reference/api-reference/lifecycle/v1alpha3/index.md b/docs/docs/reference/api-reference/lifecycle/v1alpha3/index.md index 2375e1bd4e9..e83106d9216 100644 --- a/docs/docs/reference/api-reference/lifecycle/v1alpha3/index.md +++ b/docs/docs/reference/api-reference/lifecycle/v1alpha3/index.md @@ -527,7 +527,7 @@ _Appears in:_ - +KeptnPhaseType holds long and short names of each phase supported by Keptn _Appears in:_ - [KeptnPhase](#keptnphase) diff --git a/docs/docs/reference/api-reference/lifecycle/v1beta1/index.md b/docs/docs/reference/api-reference/lifecycle/v1beta1/index.md index 2d6e43ad17a..3a855114849 100644 --- a/docs/docs/reference/api-reference/lifecycle/v1beta1/index.md +++ b/docs/docs/reference/api-reference/lifecycle/v1beta1/index.md @@ -615,7 +615,7 @@ _Appears in:_ - +KeptnPhaseType holds long and short names of each phase supported by Keptn _Appears in:_ - [KeptnPhase](#keptnphase) diff --git a/lifecycle-operator/apis/lifecycle/v1alpha1/common/phases.go b/lifecycle-operator/apis/lifecycle/v1alpha1/common/phases.go index e5e9f37acc4..c6486375978 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha1/common/phases.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha1/common/phases.go @@ -8,8 +8,10 @@ import ( "go.opentelemetry.io/otel/propagation" ) +// KeptnPhase holds long and short names of each phase supported by Keptn type KeptnPhase KeptnPhaseType +// KeptnPhaseType holds long and short names of each phase supported by Keptn type KeptnPhaseType struct { LongName string ShortName string diff --git a/lifecycle-operator/apis/lifecycle/v1alpha2/common/phases.go b/lifecycle-operator/apis/lifecycle/v1alpha2/common/phases.go index bee52c197b7..ab95421e3fd 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha2/common/phases.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha2/common/phases.go @@ -8,8 +8,10 @@ import ( "go.opentelemetry.io/otel/propagation" ) +// KeptnPhase holds long and short names of each phase supported by Keptn type KeptnPhase KeptnPhaseType +// KeptnPhaseType holds long and short names of each phase supported by Keptn type KeptnPhaseType struct { LongName string ShortName string diff --git a/lifecycle-operator/apis/lifecycle/v1alpha3/common/phases.go b/lifecycle-operator/apis/lifecycle/v1alpha3/common/phases.go index a59c8db8baf..d90dfac2c89 100644 --- a/lifecycle-operator/apis/lifecycle/v1alpha3/common/phases.go +++ b/lifecycle-operator/apis/lifecycle/v1alpha3/common/phases.go @@ -8,8 +8,10 @@ import ( "go.opentelemetry.io/otel/propagation" ) +// KeptnPhase holds long and short names of each phase supported by Keptn type KeptnPhase KeptnPhaseType +// KeptnPhaseType holds long and short names of each phase supported by Keptn type KeptnPhaseType struct { LongName string ShortName string diff --git a/lifecycle-operator/apis/lifecycle/v1beta1/common/phases.go b/lifecycle-operator/apis/lifecycle/v1beta1/common/phases.go index 050255b00c1..1eae15ee93b 100644 --- a/lifecycle-operator/apis/lifecycle/v1beta1/common/phases.go +++ b/lifecycle-operator/apis/lifecycle/v1beta1/common/phases.go @@ -8,8 +8,10 @@ import ( "go.opentelemetry.io/otel/propagation" ) +// KeptnPhase holds long and short names of each phase supported by Keptn type KeptnPhase KeptnPhaseType +// KeptnPhaseType holds long and short names of each phase supported by Keptn type KeptnPhaseType struct { LongName string ShortName string