Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add description for Component SLI Metrics reference #48959

Open
T-Lakshmi opened this issue Dec 6, 2024 · 9 comments · May be fixed by #49295 or #49334
Open

Add description for Component SLI Metrics reference #48959

T-Lakshmi opened this issue Dec 6, 2024 · 9 comments · May be fixed by #49295 or #49334
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@T-Lakshmi
Copy link
Contributor

This is a Bug Report
Problem:
Description is missing for Kubernetes Component SLI Metrics under Instrumentation page.
Proposed Solution:
Add description to Kubernetes Component SLI Metrics that should reflect under Instrumentation

image
@T-Lakshmi T-Lakshmi added the kind/bug Categorizes issue or PR as related to a bug. label Dec 6, 2024
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Dec 6, 2024
@T-Lakshmi
Copy link
Contributor Author

/sig docs
/language en
/assign

@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. language/en Issues or PRs related to English language labels Dec 6, 2024
@kundan2707
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 8, 2024
@sftim
Copy link
Contributor

sftim commented Dec 10, 2024

/remove-kind bug

Adding a description here is much more like a feature; it looks odd, but I don't see it as an actual bug.

/kind feature

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. and removed kind/bug Categorizes issue or PR as related to a bug. labels Dec 10, 2024
@sftim
Copy link
Contributor

sftim commented Dec 12, 2024

/triage accepted
/retitle Add description for Component SLI Metrics reference

@k8s-ci-robot k8s-ci-robot changed the title Description missing for Kubernetes Component SLI Metrics Add description for Component SLI Metrics reference Dec 12, 2024
@sftim
Copy link
Contributor

sftim commented Dec 12, 2024

If you tweak the PR description @T-Lakshmi, this could become a good first issue.
It's handy if we have some issues that new contributors can easily tackle.

@T-Lakshmi
Copy link
Contributor Author

Page to be updated: https://github.com/kubernetes/website/edit/main/content/en/docs/reference/instrumentation/slis.md

@T-Lakshmi
Copy link
Contributor Author

Service Level Indicator (SLI) is a measurable quantity of some relevant element of the service.

Above line can be added as a description. Refer node-metrics.md for guidance how to add description.

@T-Lakshmi
Copy link
Contributor Author

/unassign
/good-first-issue

@k8s-ci-robot
Copy link
Contributor

@T-Lakshmi:
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:

/unassign
/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.

@k8s-ci-robot k8s-ci-robot added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Jan 6, 2025
@sarthaksarthak9 sarthaksarthak9 linked a pull request Jan 6, 2025 that will close this issue
Open
This was referenced Jan 7, 2025
Closed
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
4 participants
@k8s-ci-robot @sftim @kundan2707 @T-Lakshmi