✨ Add help dialog to makefile template

[droctothorpe]

This PR:

• Recycles the self-documenting help target from the base Makefile into the makefile template that's rendered when kubebuilder init is invoked.
• Relocates the target descriptions in the template so that they can be leveraged by the help target.
• Corrects some minor typos and long lines in the base Makefile.

This PR closes: #1867

[k8s-ci-robot]

Welcome @droctothorpe!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. 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-sigs/kubebuilder 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 @droctothorpe. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

[Adirio]

/lgtm
/ok-to-test

[Adirio]

Out of curiosity, has the help description been tested under nawk (New awk), gawk (GNU awk) and mawk (Mike's awk)? We are supporting iOS and I think they use a different implementation of awk.

[droctothorpe]

Out of curiosity, has the help description been tested under nawk (New awk), gawk (GNU awk) and mawk (Mike's awk)? We are supporting iOS and I think they use a different implementation of awk.

I did not test it with nawk, gawk, and mawk since I recycled the awk implementation in the base Makefile. The update would need to happen in both places. Would you like that work to be part of this PR?

[Adirio]

Would you like that work to be part of this PR?

No, it was just curiosity. You just need an approver to set the corresponding label, I already set the lgtm one.

[camilamacedo86]

This PR closes: #1867

[Adirio]

This PR closes: #1867

@droctothorpe could you add this to the description so that the bot closes it to when merged?

[droctothorpe]

This PR closes: #1867

@droctothorpe could you add this to the description so that the bot closes it to when merged?

Done. Thank you!

[camilamacedo86]

We might decide to improve the help text and add categories in the future. However, it is great. Really thank you for your contribution:

/approve

[camilamacedo86]

/approve

Thank you for your contribution.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Adirio, camilamacedo86, droctothorpe

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 [camilamacedo86]

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