Skip to content

DOCS-1789 - Consolidate Mobot monitor-creation docs, fix sidebar label - #6981

Open
kimsauce wants to merge 2 commits into
mainfrom
DOCS-1789-consolidate-mobot-monitor-docs
Open

DOCS-1789 - Consolidate Mobot monitor-creation docs, fix sidebar label#6981
kimsauce wants to merge 2 commits into
mainfrom
DOCS-1789-consolidate-mobot-monitor-docs

Conversation

@kimsauce

@kimsauce kimsauce commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

create-monitor-with-mobot.md was published as a standalone page with no cross-reference from create-monitor.md, unlike every other alternate monitor-creation method (Terraform, dashboard/log-search entry points), which are cross-linked from the main doc rather than left to stand alone. It also has a sidebar_label plural mismatch with its sibling doc, and mobot/index.md's "Conversational Monitors" section duplicates most of its content instead of teasing it.

This PR:

  • Adds a "Using Mobot" entry under create-monitor.md's Other configurations, mirroring the existing "Using Terraform" pattern.
  • Renames create-monitor-with-mobot.md's sidebar_label from "Create Monitors with Mobot" to "Create a Monitor with Mobot", matching the singular phrasing of its sibling "Create a New Monitor."
  • Trims mobot/index.md's Conversational Monitors section to a short teaser, removing bullet lists (starting inputs, adjustable defaults, known limitations) that duplicated the dedicated doc — cutting the two-places-to-update problem down to one.

Not touched: create-monitor-with-mobot.md's own content, which is well-organized and just needed better cross-linking, not restructuring.

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

create-monitor-with-mobot.md was published as a standalone page with
no cross-reference from create-monitor.md, unlike every other
alternate creation method (Terraform, dashboard/log-search entry
points), which are cross-linked rather than left to stand alone. Add
a "Using Mobot" entry mirroring the existing Terraform pattern, fix
the sidebar_label plural mismatch with its sibling doc ("Create a New
Monitor"), and trim mobot/index.md's Conversational Monitors section
down to a teaser instead of duplicating the dedicated doc's content.

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

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

Good consolidation — verified the dedicated Mobot doc already covers everything trimmed from mobot/index.md (monitor limitations, example prompts, FAQ), so no info is lost. The "Using Mobot" section mirrors the existing "Using Terraform" pattern correctly.

One thing to fix before merge: the sidebar_label rename on create-monitor-with-mobot.md isn't matched by a title update, so the sidebar nav will say "Create a Monitor with Mobot" while the page's own H1 still renders "Create Monitors with Mobot." The two new/updated links in this PR (from create-monitor.md and mobot/index.md) also use the new singular phrasing, so readers will click through to a page whose heading doesn't match what they clicked. See inline comment.

Comment thread docs/alerts/monitors/create-monitor-with-mobot.md Outdated
Comment thread docs/search/mobot/index.md
…obot.md

Per JV0812's review: title was still plural while sidebar_label had
been updated to singular. Drop the now-redundant sidebar_label since
it matched title exactly.
@kimsauce
kimsauce requested a review from JV0812 August 4, 2026 09:41

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

Title/sidebar_label mismatch resolved — title now reads "Create a Monitor with Mobot" and matches the sidebar_label used in the new cross-links. LGTM.

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