🌱 Add missing comments with serialized prefix

[tsuzu]

What this PR does / why we need it:

• Add missing comments
• Rewrite comments to start with serialized names
  • of all Kubernetes API resource

but non-API resources are ignored. This is the list of ignored fields.

• RuntimeHooks
• version package
• clusterctl package

❯ ./hack/tools/staticchecker/staticchecker ./... 2>&1 | grep -v " Items " | grep -v " Spec " | grep -v " Status " | grep -v test | grep -v upstreamv1beta
/cluster-api/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go:30:2: Cluster should have a comment starting with 'cluster ' (missing)
/cluster-api/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go:31:2: ControlPlane should have a comment starting with 'controlPlane ' (missing)
/cluster-api/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go:32:2: MachineDeployment should have a comment starting with 'machineDeployment ' (missing)
/cluster-api/exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go:33:2: MachinePool should have a comment starting with 'machinePool ' (missing)
/cluster-api/version/version.go:69:2: Major should have a comment starting with 'major ' (missing)
/cluster-api/version/version.go:70:2: Minor should have a comment starting with 'minor ' (missing)
/cluster-api/version/version.go:71:2: GitVersion should have a comment starting with 'gitVersion ' (missing)
/cluster-api/version/version.go:72:2: GitCommit should have a comment starting with 'gitCommit ' (missing)
/cluster-api/version/version.go:73:2: GitTreeState should have a comment starting with 'gitTreeState ' (missing)
/cluster-api/version/version.go:74:2: BuildDate should have a comment starting with 'buildDate ' (missing)
/cluster-api/version/version.go:75:2: GoVersion should have a comment starting with 'goVersion ' (missing)
/cluster-api/version/version.go:76:2: Compiler should have a comment starting with 'compiler ' (missing)
/cluster-api/version/version.go:77:2: Platform should have a comment starting with 'platform ' (missing)
/cluster-api/cmd/clusterctl/api/v1alpha3/metadata_type.go:32:2: ReleaseSeries should have a comment starting with 'releaseSeries '
/cluster-api/cmd/clusterctl/cmd/version.go:32:2: ClientVersion should have a comment starting with 'clusterctl ' (missing)

I'm not a native English speaker, so I appreciate it if you tell me know gramatical mistakes or awkwardness !

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
A part of #11238

The left task is only adding missing spec status items. updated task list #11238 (comment)

[k8s-ci-robot]

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

[sbueringer]

/assign @JoelSpeed
for a first round

[sbueringer]

@tsuzu Any reason why we want to keep this PR in draft, or can we un-draft? :)

[JoelSpeed]

Potentially this reads better?

Suggested change

	// timeout is the duration after which a node is considered unhealthy
	// if the condition has been in the given status.
	// timeout is the duration that a node must be in a given status for,
	// after which the node is considered unhealthy.
	// For example, with a value of "1h", the node must match the status
	// for at least 1 hour before being considered unhealthy.

[JoelSpeed]

Perhaps include the suggestion I made on the v1beta1 type

[JoelSpeed]

Perhaps include the description suggestion I had on the v1beta1 type

[tsuzu]

@tsuzu Any reason why we want to keep this PR in draft, or can we un-draft? :)

Ah, sorry! I'd have liked to recheck the description and changes.
I've changed to Ready for review. Thank you for your review!

[sbueringer]

/ok-to-test

(probably needs make generate manifests)

[tsuzu]

(probably needs make generate manifests)

I usually forget it... Thank you!

[sbueringer]

Thx!

/approve
/lgtm

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: ed180bac94037ee52b84fcd75aca97e769f54f65

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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

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