Address comments

This commit is contained in:
Hidde Beydals 2020-04-16 12:08:09 +02:00 committed by stefanprodan
parent 8b4432fc5c
commit 000bf41dc2
3 changed files with 9 additions and 7 deletions

View File

@ -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)://"

View File

@ -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"
)
```

View File

@ -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.