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>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
@kimsauce add to this PR: for style guide: |
JV0812
left a comment
There was a problem hiding this comment.
Reviewed all 29 files. The new glossary entries, the Accessibility section in the style guide, and the de-italicizing cleanup across docs are all solid and consistent. CI is green.
Found a few concrete issues before I approve:
Glossary alphabetization (a few entries landed out of order):
Creditis inserted betweenCardinalityandClobber— it should sort afterCloud-to-Cloud Integration Framework, before theDsection.Audit Indexis inserted beforeApps—Appsshould come first (App<Aud).Health Eventsis inserted beforeHash rules—Hash<Health(a<e).Logs for Securityis inserted beforeLog Analysis Agent,LogCompare, andLogReduce— it should come after those, beforeLogs-to-Metrics.
Word list: Manipulate is placed after Messages tab, before Multiline — alphabetically it belongs before MB and Mbit, right after Login vs Log In.
Content regression, not just a style tweak: in docs/alerts/webhook-connections/set-up-webhook-connections.md, the inline definition of "webhook" was removed entirely (not just de-italicized like elsewhere in this PR):
-A *webhook* is an HTTP callback, which is an HTTP POST that occurs when something happens. Webhook connections allow you to send Sumo Logic alerts to third-party applications that accept incoming webhooks.
+Webhook connections allow you to send Sumo Logic alerts to third-party applications that accept incoming webhooks.
I checked — there's no standalone Webhook entry in glossary.md to link to instead (only a passing mention inside the Alert entry). Unlike the other inline-definition removals in this PR, which point to a new or existing glossary entry, this one just drops the definition with nothing to replace it. Either restore a trimmed version of the definition, or add a Webhook glossary entry and link to it here.
Happy to re-review once these are in.
…ation, restore webhook definition - Move Audit Index, Credit, Health Events, and Logs for Security to their correct alphabetical position in glossary.md - Move Manipulate to its correct alphabetical position in word-list.md - Restore the webhook definition sentence in set-up-webhook-connections.md that was dropped instead of de-italicized Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
@JV0812 Thanks for catching these. All four are fixed in 35950ad:
Ready for another look. |
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