Skip to content

Typo in docs of custom resources after PR #1777 #1855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gadisn opened this issue Oct 16, 2022 · 2 comments · Fixed by #1856
Closed

Typo in docs of custom resources after PR #1777 #1855

gadisn opened this issue Oct 16, 2022 · 2 comments · Fixed by #1856
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@gadisn
Copy link

gadisn commented Oct 16, 2022

What happened:
The new 'type' field for custom metrics, as added in #1777, should be under 'each', see:

https://github.com/kubernetes/kube-state-metrics/blob/master/pkg/customresourcestate/registry_factory.go#L65
https://github.com/kubernetes/kube-state-metrics/blob/master/pkg/customresourcestate/registry_factory.go#L136

The problem is in line 46 in https://github.com/kubernetes/kube-state-metrics/edit/master/docs/customresourcestate-metrics.md

What you expected to happen:

How to reproduce it (as minimally and precisely as possible):

Anything else we need to know?:

Environment:

  • kube-state-metrics version:
  • Kubernetes version (use kubectl version):
  • Cloud provider or hardware configuration:
  • Other info:
@gadisn gadisn added the kind/bug Categorizes issue or PR as related to a bug. label Oct 16, 2022
@gadisn
Copy link
Author

gadisn commented Oct 16, 2022

@chrischdi FYI

@chrischdi
Copy link
Member

Thanks for reporting @gadisn 😄 👍 I opened a PR to fix the document

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants