flux2 icon indicating copy to clipboard operation
flux2 copied to clipboard

Documentation "Manage Helm Releases" needs clarification

Open guidoffm opened this issue 3 years ago • 1 comments

Describe the bug

https://fluxcd.io/docs/guides/helmreleases/#define-a-helm-release

The example reads:

version: '4.0.x'

There is no description what 4.0.x means. This is afaik not a legal SemVer v2 version number. If this any kind of wildcard this should be described.

Steps to reproduce

n/a

Expected behavior

Clarification

Screenshots and recordings

No response

OS / Distro

n/a

Flux version

n/a

Flux check

n/a

Git provider

No response

Container Registry provider

No response

Additional context

No response

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

guidoffm avatar Nov 19 '21 13:11 guidoffm

The x is a wildcard just like *, and is used in various places in the Helm documentation as well.

While I do agree that it could be highlighted somewhere for clearance, I do think most people being interested in Helm would know this, as Helm uses the same format: https://helm.sh/docs/topics/charts/#the-kubeversion-field, as do many other tools and languages in the general world of software.

hiddeco avatar Nov 19 '21 14:11 hiddeco