kube-state-metrics icon indicating copy to clipboard operation
kube-state-metrics copied to clipboard

docs(options): Slightly improve comments for the `NodeType` set type

Open LaikaN57 opened this issue 1 year ago • 6 comments

What this PR does / why we need it: Improves docs to help developers.

How does this change affect the cardinality of KSM: does not change cardinality

Which issue(s) this PR fixes: n/a

Updates: https://github.com/kubernetes/kube-state-metrics/commit/d1f04c2479c792d15e420255d5c6829fdd95766c

LaikaN57 avatar Jun 06 '24 08:06 LaikaN57

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: LaikaN57 Once this PR has been reviewed and has the lgtm label, please assign rexagod for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

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

k8s-ci-robot avatar Jun 06 '24 08:06 k8s-ci-robot

Welcome @LaikaN57!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. 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/kube-state-metrics 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. :smiley:

k8s-ci-robot avatar Jun 06 '24 08:06 k8s-ci-robot

cc: @mickeyzzc

LaikaN57 avatar Jun 06 '24 08:06 LaikaN57

/hold

I might change NodeType back to string. Because got one comment that existing NodeType is a little confusing.

CatherineF-dev avatar Jun 07 '24 12:06 CatherineF-dev

/assign @CatherineF-dev /triage accepted

dgrisonnet avatar Jun 13 '24 16:06 dgrisonnet