Conversation
- Convert italicized term definitions to links (Scheduled Search, Installed Collector, entity, suppressed signal, related signal/insight, detected relationship, node, credit, Logs for Security) - Add 10 new glossary entries: Alert (expanded), Monitor, Keyword Search Expression, Scheduled action, Node, Credit, Related signal, Related insight, Detected relationship, Suppressed signal, Logs for Security - Remove italics from common industry terms (webhook definition sentence dropped), SRE standard terms (SLI, SLO, compliance period, error budget), and terms on their own feature pages - Fix non-breaking space in transactionize-operator.md - Convert argument names to backtick code formatting in deploy-with-terraform.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…em dash preference from sumo-style skill Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
kimsauce
changed the title
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
4 tasks
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
1 participant
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
Contributing documentation improvements across four areas: glossary expansion, word list/style guide updates, style guide additions, and inline definition cleanup across docs.
Glossary — 30+ new entries including: Alert, Analyst, Audit Index, Automation Bridge, Cloud-to-Cloud Integration Framework, Credit, Data Tiers, Detected relationship, Dynamic Parsing,
fieldsoperator, Flex Account,formatDateoperator, Health Events, Keyword Search Expression, Log Analysis Agent, Logs for Security, Lookup Table, MCP Server, Monitor, Node,parse json/keyvalue/nodrop/regexoperators, Platform Optimization Agent, Playbook, Real User Monitoring, Related insight, Related signal, Scheduled action, SOC Analyst Agent, Suppressed signal, Threat Intelligence. Updated entries: Mobot, Rule (expanded with all six Cloud SIEM rule types).Word list — New entries: Aka, Backend, Checkbox (changed to one word), Dropdown (simplified), Lifecycle, Manipulate, Real time/real-time, Timeout. Updated entries: Collector (OpenTelemetry Collector exception), E.g./i.e./etc. (rewritten to match style guide intent), Em dash and en dash (redirects to style guide Dashes section).
Style guide — New Dashes section (em dash and en dash usage). New Accessibility section (WCAG 2.1 AA baseline, heading hierarchy, color and contrast, screen reader testing).
Inline definition cleanup — Across 25+ docs pages: converted italicized Sumo Logic term definitions to glossary links, removed redundant inline definitions for common industry terms and SRE standard terms (SLI, SLO, compliance period, error budget), and fixed minor formatting issues.
Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-482