VPA Improving Flags Documentation Generation Process

[omerap12]

Currently, the process for generating the flags documentation for the VPA involves running the script: vertical-pod-autoscaler/hack/create-flags-doc-vpa.sh. This script triggers make document-flags in each VPA component and then combines the output into a single file: vertical-pod-autoscaler/docs/flags.md.

While this method works, we’d like to improve it by adopting a more streamlined approach similar to how the cluster-autoscaler generates its flags documentation. Specifically, we want to leverage the flags package’s auto-generated documentation by simply calling the binaries.

For reference: #7642 (comment)

I’ve made some progress on this, but any additional help would be appreciated (feel free to assign it to yourself).

/assign
/kind documentation

[omerap12]

/kind good-first-issue

[k8s-ci-robot]

@omerap12: The label(s) kind/good-first-issue cannot be applied, because the repository doesn't have them.

In response to this:

/kind 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-sigs/prow repository.

[omerap12]

/good-first-issue

[k8s-ci-robot]

@omerap12:
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:

/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-sigs/prow repository.

[adrianmoisey]

/area vertical-pod-autoscaler