-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
docs: Clarify Unit Requirement for Duration Comparison in Label Values #13318
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sure, here's a suitable pull request description: Description This update clarifies the requirement for units within the original label value when making a Duration comparison. It ensures that users understand the necessity of including a unit suffix (e.g., 'ms', 'h') for accurate parsing and comparison. Changes Updated documentation to specify that the label value must include a unit suffix. Added examples and notes about using label_format to modify the value and append the unit before comparison. Motivation and Context Clarifies the need for units within the original label value when making a Duration comparison, preventing potential parsing errors and improving the accuracy of comparisons.
ghost
self-requested a review
as a code owner
June 25, 2024 16:55
github-actions
bot
added
the
type/docs
Issues related to technical documentation; the Docs Squad uses this label across many repositories
label
Jun 25, 2024
ghost
changed the title
Clarify Unit Requirement for Duration Comparison in Label Values
docs: Clarify Unit Requirement for Duration Comparison in Label Values
Jun 25, 2024
This PR must be merged before a backport PR will be created. |
1 similar comment
This PR must be merged before a backport PR will be created. |
JStickler
approved these changes
Jun 25, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Docs team] LGTM, thanks for taking the time to improve the docs!
grafanabot
pushed a commit
that referenced
this pull request
Jun 25, 2024
#13318) Co-authored-by: J Stickler <[email protected]> (cherry picked from commit 5570855)
grafanabot
pushed a commit
that referenced
this pull request
Jun 25, 2024
#13318) Co-authored-by: J Stickler <[email protected]> (cherry picked from commit 5570855)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
backport release-2.9.x
backport release-3.0.x
size/XS
type/docs
Issues related to technical documentation; the Docs Squad uses this label across many repositories
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This update clarifies the requirement for units within the original label value when making a Duration comparison. It ensures that users understand the necessity of including a unit suffix (e.g., 'ms', 'h') for accurate parsing and comparison.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Checklist
CONTRIBUTING.md
guide (required)feat
PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.md
production/helm/loki/Chart.yaml
and updateproduction/helm/loki/CHANGELOG.md
andproduction/helm/loki/README.md
. Example PRdeprecated-config.yaml
anddeleted-config.yaml
files respectively in thetools/deprecated-config-checker
directory. Example PR