helm-docs icon indicating copy to clipboard operation
helm-docs copied to clipboard

Published 20 hours ago • verified publisher icon norwoodj

[Enhancement] Rename Requirements to Dependencies

Open nicholaswilde opened this issue 4 years ago • 4 comments

I would be nice to have the nomenclature of the requirements/dependencies match helm to avoid confusion. Helm documents them as dependencies whereas helm-docs state them as requirements.

nicholaswilde avatar Feb 06 '21 21:02 nicholaswilde

Agreed, I'll merge a PR, or get to this myself... someday soon

norwoodj avatar Apr 26 '21 20:04 norwoodj

Hi @norwoodj ,

I'm using your project for our Helm charts documentation - thanks for that - and I was looking for a good first issue I could contribute with. Please let me know in the PR if there's anything I should improve.

Cheers!

cebidhem avatar Jul 27 '22 22:07 cebidhem

Just bumped into this issue after trying to figure out why the requirementsSection is not rendering anything.

Think the mentioned pull request #161 looks like a solution to me. Anything that would have to be tweaked on the PR to make it increase it's chances of being merged?

johbo avatar Mar 24 '23 04:03 johbo

Following up on my own message to avoid that anyone else gets trapped in the same way:

My issue was caused by a wrong value in my Chart.yaml regarding the attribute apiVersion. If that's set to "v1", then helm-docs is correctly ignoring the attribute dependencies.

The mentioned PR and this issue are about consistent naming only I think.

johbo avatar Mar 24 '23 05:03 johbo