DOCS-1605 - Add frontmatter descriptions to parse operators#6678
Open
JV0812 wants to merge 2 commits into
Open
DOCS-1605 - Add frontmatter descriptions to parse operators#6678JV0812 wants to merge 2 commits into
JV0812 wants to merge 2 commits into
Conversation
Add comprehensive SEO-friendly descriptions to all 9 parse operator documentation files. Each description is 49-63 words and includes: - Clear explanation of operator functionality - Supported formats and options - Practical use cases and benefits - Keywords for improved search discoverability This enhances SEO visibility and helps users quickly understand what each parse operator does from search results and page previews. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Collaborator
|
Thanks for adding these, Jagadisha! One issue to address: Descriptions are too long (critical) All 9 descriptions are 311–372 characters. The hard limit for Google to display a full meta description is 160 characters — anything over that gets truncated mid-sentence in search results, which defeats the purpose of adding them. Ideal range is 140–160 characters. Each description should be trimmed to the first 1–2 sentences that capture what the operator does, cutting the "Useful for..." and "Ideal for..." trailing sentences. |
- 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
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 9 parse operator documentation files. These descriptions improve search discoverability and provide clear summaries of parsing capabilities for different log formats.
Summary of Changes:
description:field to frontmatter of 9 parse operator docsBefore: Files had no frontmatter descriptions
After: All files have concise, format-specific descriptions
Example additions:
parse-csv-formatted-logs.md: "Use the parse operator to extract fields from CSV-formatted log entries..."parse-keyvalue-formatted-logs.md: "Use thekeyvalueparse operator to extract key-value pairs from log messages..."parsedate.md: "Use theparseDateoperator to parse date and time strings from log entries..."Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-1605