From 000bf41dc2f2034c1b94150bb5d164600ceed734 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Thu, 16 Apr 2020 12:08:09 +0200 Subject: [PATCH] Address comments --- docs/spec/v1alpha1/gitrepositories.md | 5 +++-- docs/spec/v1alpha1/helmcharts.md | 9 +++++---- docs/spec/v1alpha1/helmrepositories.md | 2 +- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/spec/v1alpha1/gitrepositories.md b/docs/spec/v1alpha1/gitrepositories.md index 7addbce8..f168db3f 100644 --- a/docs/spec/v1alpha1/gitrepositories.md +++ b/docs/spec/v1alpha1/gitrepositories.md @@ -1,6 +1,6 @@ # Git Repositories -The `GitReposiory` API defines a source for artifacts coming from Git. The +The `GitRepository` API defines a source for artifacts coming from Git. The resource exposes the latest synchronized state from Git as an artifact in an archive. @@ -9,7 +9,8 @@ an archive. Git repository: ```go -// GitRepositorySpec defines the desired state of a Git repository. +// GitRepositorySpec gives the specification for fetching a Git repository as +// a source. type GitRepositorySpec struct { // The repository URL, can be a HTTP or SSH address. // +kubebuilder:validation:Pattern="^(http|https|ssh)://" diff --git a/docs/spec/v1alpha1/helmcharts.md b/docs/spec/v1alpha1/helmcharts.md index 68fb0065..a5d90476 100644 --- a/docs/spec/v1alpha1/helmcharts.md +++ b/docs/spec/v1alpha1/helmcharts.md @@ -9,7 +9,7 @@ exposes the latest pulled chart for the defined version as an artifact. Helm chart: ```go -// HelmChart defines the desired state of a Helm chart. +// HelmChartSpec defines the desired state of a Helm chart source. type HelmChartSpec struct { // The name of the Helm chart, as made available by the referenced // Helm repository. @@ -36,7 +36,7 @@ type HelmChartSpec struct { ```go // HelmChartStatus defines the observed state of the HelmChart. -type HelmRepositoryStatus struct { +type HelmChartStatus struct { // +optional Conditions []SourceCondition `json:"conditions,omitempty"` @@ -56,10 +56,11 @@ type HelmRepositoryStatus struct { const ( // ChartPullFailedReason represents the fact that the pull of the // given Helm chart failed. - ChartPullFailedReason string = "ChartPullFailed" + ChartPullFailedReason string = "ChartPullFailed" + // ChartPullSucceededReason represents the fact that the pull of // the given Helm chart succeeded. - ChartPullSucceedReason string = "ChartPullSucceeded" + ChartPullSucceededReason string = "ChartPullSucceeded" ) ``` diff --git a/docs/spec/v1alpha1/helmrepositories.md b/docs/spec/v1alpha1/helmrepositories.md index 1942129c..0649a1f8 100644 --- a/docs/spec/v1alpha1/helmrepositories.md +++ b/docs/spec/v1alpha1/helmrepositories.md @@ -9,7 +9,7 @@ an artifact. Helm repository: ```go -// HelmRepository defines the reference to a Helm repository. +// HelmRepositorySpec defines the reference to a Helm repository. type HelmRepositorySpec struct { // The Helm repository URL, a valid URL contains at least a // protocol and host.