docs(charts): using helm-docs for chart

[sc250024]

Description

This enables the use of the helm-docs tool on the Helm chart located in charts/ingress-nginx. This will make it possible to automatically document new variables in the values.yaml file.

What this PR does / why we need it:

This PR improves the documentation for the chart so that possible configuration values are documented automatically.

It also adds CI checks so that moving forward, someone adding / removing / updating values in the Helm chart will have to make sure that helm-docs has been run.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation only

Which issue/s this PR fixes

Not applicable

How Has This Been Tested?

Testing is not necessary since the documentation has already been generated.

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I've read the CONTRIBUTION guide
• I have added tests to cover my changes.
• All new and existing tests passed.

[k8s-ci-robot]

@sc250024: This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-ci-robot]

Welcome @sc250024!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @sc250024. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[sc250024]

@cpanato @ElvinEfendi Any comments on this?

[rikatz]

@sc250024 this is amazing!! Thanks for the PR.

I'm not a helm expert, but will follow on this one and also ping the dev team so someone can take a look into the implications. But the idea is great! :)

[rikatz]

/assign

[tao12345666333]

LGTM! helm-docs is a good tool.

I will review the template and related configuration later.

/assign

[cpanato]

looks cool!
/approve

[sc250024]

@rikatz Looks like we just need your input. Would you mind approving please? Or do you have any more suggestions?

[rikatz]

I just want to take a final look before approving :) will do between today and tomorrow.

Thanks!

[rikatz]

/assign

[sc250024]

Cool, thank you @rikatz !

[tao12345666333]

Thanks, left some comments.

[rikatz]

/ok-to-test
/lgtm
/approve
/hold
For final @tao12345666333 comments

Overall this is great, and by the same time it's so ugly that we have a full Readme and no comments in the fields / values :D

Seems like a good first issue to fix that in the chart, so we may have everything properly documented, + any new value on it should be documented as well.

Thanks @sc250024 !

[tao12345666333]

Thanks!

/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cpanato, rikatz, sc250024, tao12345666333

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [rikatz]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[sc250024]

@rikatz Is this good for a merge finally? Thank you!

[sc250024]

@rikatz Ping 🤙

[rikatz]

/hold cancel
Thanks :)

[sc250024]

@rikatz It looks like the job has failed => https://github.com/kubernetes/ingress-nginx/runs/4747631693?check_suite_focus=true .

Do you know whom to notify about this error?

Error: error creating GitHub release: POST api.github.com/repos/kubernetes/ingress-nginx/releases: 401 Bad credentials []

@aledbf Maybe?

[rikatz]

Nope it's with me. I will try to look this week, ok?

[longwuyuan]

hi @sc250024 #8125 (comment)