Improve helm lint documentation clarity #1637
Conversation
Clarified helm lint --with-subcharts option documentation Signed-off-by: Mykola <[email protected]>
|
To me, the documentation is still unclear: I don't understand what this option does, especially since the linting behavior is so different from |
|
@astellingwerf, so the thing I am trying to emphasize there is that when you run
But on the other hand, when the |
| @@ -35,7 +35,7 @@ helm lint PATH [flags] | |||
| --skip-schema-validation if set, disables JSON schema validation | |||
| --strict fail on lint warnings | |||
| -f, --values strings specify values in a YAML file or a URL (can specify multiple) | |||
| --with-subcharts lint dependent charts | |||
| --with-subcharts lint subcharts as independent charts (note that without this option, the chart will be validated as a whole, including subcharts as its part) | |||
There was a problem hiding this comment.
This document is generated from Helm itself. So are all the files in this directory.
It needs to be changed at https://github.com/helm/helm/blob/ecc4adee692333629dbe6343fbcda58f8643b0ca/cmd/helm/lint.go#L149.
Please update it in the other location.
Clarified helm lint --with-subcharts option documentation
Please note helm/helm#12027 -- abovementioned unclear part caused many people to struggle
Please help with other languages documentatiton