Skip to content

Commit

Permalink
mark chart.spec.version as specific to HelmRepository source in example
Browse files Browse the repository at this point in the history
In my opinion it is not visible enough that `chart.spec.version` is only considered for `HelmRepository` sources (and silently ignored otherwise.
I'm aware that the text below the example mentions this, but I think it would be benefitial for the code example itself to make that fact clear.

Adding this comment is only a suggestion (which I'm not 100% happy with myself) -- feel free to substitute a different way of pointing out the connection between `HelmRepository` and the version spec.

Signed-off-by: Tom Janson <[email protected]>
  • Loading branch information
tjanson authored and Tom Janson committed Jan 20, 2022
1 parent 5913aa7 commit 783483c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion content/en/docs/guides/helmreleases.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ spec:
chart:
spec:
chart: <name|path>
version: '4.0.x'
version: '4.0.x' # only when using HelmRepository
sourceRef:
kind: <HelmRepository|GitRepository|Bucket>
name: podinfo
Expand Down

0 comments on commit 783483c

Please sign in to comment.