Skip to content

DOCS-1798 - Cross-link Mobot on high-traffic search docs - #7058

Merged
kimsauce merged 3 commits into
mainfrom
DOCS-1798
Aug 26, 2026
Merged

DOCS-1798 - Cross-link Mobot on high-traffic search docs#7058
kimsauce merged 3 commits into
mainfrom
DOCS-1798

Conversation

@kimsauce

@kimsauce kimsauce commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

This pull request cross-links Mobot from high-traffic pages where users are currently writing queries or configuration by hand, pointing to Mobot as a plain-language alternative:

  • The top-trafficked /docs/search hub pages (search query language, search operators, parse operators, group/aggregate operators, get-started-with-search, cheat sheets), plus the remaining search-query-language sibling hubs that were missed in the first pass (field expressions, math expressions, transaction analytics).
  • Monitors Overview, pointing to Create a Monitor with Mobot.
  • The top-level Get Started welcome page.
  • The OpenTelemetry Collector overview, matching the how-to example Mobot's own doc already uses.

Also restores a previously-shelved Mobot callout on query-assist.md (now consuming the shared partial), and rewrites the shared mobot-callout.md partial as a business-value blurb sourced from the Dojo AI self-paced course, rather than a generic feature description.

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-1798

Add a shared Mobot tip admonition to the top-trafficked search hub pages (query language, operators, parse operators, group/aggregate operators, get-started, cheat sheets) and restore the previously-shelved callout on query-assist.md, to surface Mobot as an alternative to writing queries by hand.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@kimsauce kimsauce self-assigned this Aug 25, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Aug 25, 2026
…-started, and OTel Collector

Rewrite the shared mobot-callout.md partial as a business-value blurb
(sourced from the Dojo AI course) instead of a generic feature description.

Add the callout to:
- The search-query-language sibling hubs missed in the initial pass
  (field expressions, math expressions, transaction analytics).
- Monitors Overview, pointing to Create a Monitor with Mobot.
- The top-level Get Started welcome page.
- The OpenTelemetry Collector overview, matching the how-to example
  Mobot's own doc already uses.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@kimsauce
kimsauce marked this pull request as ready for review August 26, 2026 11:00
@kimsauce
kimsauce requested review from a team, JV0812, amee-sumo and mafsumo as code owners August 26, 2026 11:00
@JV0812

JV0812 commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator

Review

Verdict: Approve, with one coordination flag to raise before merging.

What it does: Adds a new shared partial docs/reuse/mobot-callout.md (a :::tip pointing to /docs/search/mobot) and imports/renders it on 8 high-traffic search hub/reference pages. Two other pages (alerts/monitors/overview.md, get-started/index.md) get a standalone, non-partial :::tip instead (different target link each), and send-data/opentelemetry-collector/index.md gets a third standalone tip. Matches the stated goal in DOCS-1798 ("Cross-link Mobot to high-ranking /docs/search pages").

Verified:

  • yarn build on this branch completes with no errors — all ~10 import MobotCallout from '...' relative paths (../reuse/, ../../reuse/, ../../../reuse/ depending on nesting) resolve correctly.
  • Link targets are valid: /docs/search/mobot and /docs/alerts/monitors/create-monitor-with-mobot.
  • No pre-existing Mobot mentions on the touched pages that would now duplicate the new callout.
  • Content matches the Jira ticket's ask.

Flag before merging — cross-PR conflict risk:
docs/search/query-assist.md is modified here (a commented-out Mobot callout is uncommented and replaced with <MobotCallout/>), but #7061 ("DOCS-1827 - Consolidate Query Assist into Search Autocomplete") — still open — deletes this exact file entirely, merging its content into search-autocomplete.md. Whichever PR merges second should account for the other:

Flagging the same on #7061 so whoever finishes it second carries the callout over.

Minor/non-blocking: the two standalone tips in alerts/monitors/overview.md and get-started/index.md don't use the new MobotCallout partial — each links to a more contextually specific target, so likely intentional, but worth a quick confirmation.

@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.

Verified builds cleanly on the PR branch and all MobotCallout import paths resolve. Approving — see comment above for a merge-sequencing note re: #7061.

@kimsauce
kimsauce added this pull request to the merge queue Aug 26, 2026
Merged via the queue into main with commit a47b7b6 Aug 26, 2026
4 checks passed
@kimsauce
kimsauce deleted the DOCS-1798 branch August 26, 2026 11:55
kimsauce added a commit that referenced this pull request Sep 2, 2026
Resolves the query-assist.md modify/delete conflict by honoring the
deletion. Preserves PR #7058's intent by adding <MobotCallout/> to the
consolidated search-autocomplete.md, and restores the original page's
Alt+Space / Alt+Esc shortcuts in a new Keyboard shortcuts section.

Also applies audit fixes to search-autocomplete.md (trim description to
<=160 chars, remove em dash, "GA" -> "full release" to match the July
2025 release note) and trims the duplicated AI Parse Assist disambiguation
note in parse-predictable-patterns-using-an-anchor.md to a pointer.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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