DOCS-1605 - Add frontmatter descriptions to metrics operators#6679
Open
JV0812 wants to merge 2 commits into
Open
DOCS-1605 - Add frontmatter descriptions to metrics operators#6679JV0812 wants to merge 2 commits into
JV0812 wants to merge 2 commits into
Conversation
Add comprehensive SEO-friendly descriptions to all 24 metrics operator documentation files. Each description is 49-65 words and includes: - Clear explanation of operator functionality - Grouping and aggregation capabilities - Practical use cases and benefits - Keywords for improved search discoverability Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
kimsauce
reviewed
May 11, 2026
Collaborator
kimsauce
left a comment
kimsauce
left a comment
There was a problem hiding this comment.
Thank you again for adding these descriptions. Had the same comment as the search operator PR: #6677 (comment)
- Trim descriptions to 140-160 characters (Google display limit) - Remove backticks from description field (plain text only) - Keep only first 1-2 sentences that capture operator purpose Addresses PR review feedback on DOCS-1605
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Purpose of this pull request
This pull request adds comprehensive SEO-friendly frontmatter descriptions to all 24 metrics operator documentation files. These descriptions improve search discoverability and provide clear summaries of metric aggregation and analysis capabilities.
Summary of Changes:
description:field to frontmatter of 24 metrics operator docsBefore: Files had no frontmatter descriptions
After: All files have concise, metrics-focused descriptions
Example additions:
quantize.md: "Use thequantizemetrics operator to control quantization behavior by specifying time bucket size and rollup type..."avg.md: "Use theavgmetrics operator to calculate the average value of time series..."topk.md: "Use thetopkmetrics operator to select the top K time series based on their aggregated values..."Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-1605