Skip to content

DOCS-482 - Expand glossary, word list, and style guide for contributors - #7089

Open
kimsauce wants to merge 8 commits into
mainfrom
DOCS-482
Open

DOCS-482 - Expand glossary, word list, and style guide for contributors#7089
kimsauce wants to merge 8 commits into
mainfrom
DOCS-482

Conversation

@kimsauce

@kimsauce kimsauce commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

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, fields operator, Flex Account, formatDate operator, Health Events, Keyword Search Expression, Log Analysis Agent, Logs for Security, Lookup Table, MCP Server, Monitor, Node, parse json/keyvalue/nodrop/regex operators, 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

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-482

@kimsauce kimsauce self-assigned this Sep 2, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Sep 2, 2026
- 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>
kimsauce and others added 2 commits September 2, 2026 05:38
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 kimsauce changed the title DOCS-482 - Map italicized definitions to glossary entries DOCS-482 - Expand glossary, word list, and style guide for contributors Sep 2, 2026
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kimsauce

kimsauce commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator Author

@kimsauce add to this PR:

for style guide:

### Concise, human phrasing

Write the way a knowledgeable colleague would explain something in person. Cut anything that does not carry information. This also keeps our docs from reading like generic AI output.

* **No throat-clearing.** Start with the point. Drop preambles like "It's worth noting that", "It's important to understand", and "In this section, we will".
* **No filler.** Cut "simply", "just", "of course", "as you can see", "needless to say", and intensifiers like "very", "really", and "quite".
* **Do not restate.** Skip summary sentences that repeat what the paragraph, list, or procedure just said.
* **One idea per sentence.** Prefer short sentences over long ones stitched together with "and", "which", or semicolons.
* **Say it once.** When two sentences make the same point, keep the clearer one and delete the other.
### Dashes

Try not to use em dashes (the long dash) as they read as generic AI output. Rewrite instead: use a period or semicolon to split two independent clauses, a colon to introduce something, or commas or parentheses for a brief aside.

Use the en dash (–) only for numeric and date ranges, with no space on either side: `9–17`, `2023–2024`. See [Numbers](#numbers) and [Dates](#dates).

Use the hyphen (-) for compound modifiers, such as `drop-down menu` or `read-only field`.

@kimsauce
kimsauce marked this pull request as ready for review September 10, 2026 22:57
@kimsauce
kimsauce requested review from a team, JV0812, amee-sumo and mafsumo as code owners September 10, 2026 22:57

@JV0812 JV0812 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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):

  • Credit is inserted between Cardinality and Clobber — it should sort after Cloud-to-Cloud Integration Framework, before the D section.
  • Audit Index is inserted before AppsApps should come first (App < Aud).
  • Health Events is inserted before Hash rulesHash < Health (a < e).
  • Logs for Security is inserted before Log Analysis Agent, LogCompare, and LogReduce — it should come after those, before Logs-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>
@kimsauce

Copy link
Copy Markdown
Collaborator Author

@JV0812 Thanks for catching these. All four are fixed in 35950ad:

  • Audit Index, Credit, Health Events, and Logs for Security moved to their correct alphabetical spots in glossary.md
  • Manipulate moved to its correct spot in word-list.md
  • Restored the webhook definition in set-up-webhook-connections.md, de-italicized instead of dropped, matching how the rest of this PR handled inline definitions

Ready for another look.

@kimsauce
kimsauce requested a review from JV0812 September 11, 2026 05:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants