Add comments for values in values.yaml

[longwuyuan]

• We recently adopted helm-docs https://github.com/norwoodj/helm-docs
• The helm-docs tool autogenerates README.md
• Autogenerated README.md creates a table of all the values in values.yaml
• The last column of the table is the description of the value
• The description is picked up from the comments above each value in values.yaml
• Several values in values.yaml do not have comments
• This issue is to edit values.yaml to ensure all values have comments
• Links for reference
  • RELEASE.md in the root of the project
  • PR related to changes like helm-docs changes for release v1.1.1 #8125
  • PR that introduced helm-docs to the project docs(charts): using helm-docs for chart #8061

/remove-kind bug
/kind documentation
/area docs
/good-first-issue

[k8s-ci-robot]

@longwuyuan:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

• We recently adopted helm-docs https://github.com/norwoodj/helm-docs
• The helm-docs tool autogenerates README.md
• Autogenerated README.md creates a table of all the values in values.yaml
• The last column of the table is the description of the value
• The description is picked up from the comments above each value in values.yaml
• Several values in values.yaml do not have comments
• This issue is to edit values.yaml to ensure all values have comments
• Links for reference
• RELEASE.md in the root of the project
• PR related to changes like helm-docs changes for release v1.1.1 #8125
• PR that introduced helm-docs to the project docs(charts): using helm-docs for chart #8061

/remove-kind bug
/kind documentation
/area docs
/good-first-issue

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]

@longwuyuan: 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.

[longwuyuan]

@manikanth04 you can take this one if interested to pair with me. This can be done slowly as there is no rush on the achievable here. But this should eventually be accomplished

[manikanth04]

/assign @manikanth04

[manikanth04]

Sure @longwuyuan

[jatinTyagi98]

I want to work on this
/assign

[longwuyuan]

@jatinTyagi98 do you have any questions

[jatinTyagi98]

@longwuyuan can you direct to me to the file which I should look into as I am new to k8s and helms.

[longwuyuan]

looking into a file may not provide all the help needed. please try to use the ingress controller in a private cluster. see if the documentation of the controller helps you understand better. the requirement is to add comments on each key in the /charts/ingress-nginx/values.yaml, that is missing comments/documentation inside the values.yaml file.

you could ask questions in slack, if there is no documentation related to the key in the controller's documentation website or in the markdown files in the github repo.

[jatinTyagi98]

@longwuyuan I have added some comments in the values.yaml file and just to be sure that I am going in the right direction. Would you care to look into it ? I can create a PR with the minimum changes I have made and If you confirm that it is right then I will do the rest of the work.

[longwuyuan]

@indhupriya Can you help on this one and comment on last update from @jatinTyagi98

[longwuyuan]

@indhupriya this is the one i was referring to on slack

[jatinTyagi98]

@longwuyuan @indhupriya I have created a PR for the review . Any feedback would be helpful.

[indhupriya]

will do @longwuyuan

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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.