Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Enhancement] Rename Requirements to Dependencies #88

Open
nicholaswilde opened this issue Feb 6, 2021 · 4 comments · May be fixed by #161
Open

[Enhancement] Rename Requirements to Dependencies #88

nicholaswilde opened this issue Feb 6, 2021 · 4 comments · May be fixed by #161
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@nicholaswilde
Copy link

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 nicholaswilde changed the title Rename Requirements to Dependencies [Enhancement] Rename Requirements to Dependencies Feb 6, 2021
@norwoodj
Copy link
Owner

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

@norwoodj norwoodj added bug Something isn't working good first issue Good for newcomers labels Apr 26, 2021
@cebidhem cebidhem linked a pull request Jul 27, 2022 that will close this issue
Open
@cebidhem
Copy link

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!

@johbo
Copy link

johbo commented Mar 24, 2023

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
Copy link

johbo commented Mar 24, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working good first issue Good for newcomers
Projects
Helm Docs Improvement
Status: No status
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: renamed requirements to dependencies to match Helm standards cebidhem/norwoodj-helm-docs
4 participants
@johbo @nicholaswilde @norwoodj @cebidhem