[DOCS-13278] Add NDM Summary Page documentation#36509
Draft
domalessi wants to merge 12 commits into
Draft
Conversation
Document the new Network Device Monitoring Summary Page, including filters, network health, interface and device performance with threshold tables, traffic, and recent configuration changes. Add the page to the NDM section index and the side nav. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
Architecture
Contributor
Preview links (active after the
|
Trim UI inventory descriptions and add framing intros to the threshold tables. Add placeholder screenshots for the filter bar, network health, status counters, issues, interface performance, device performance, traffic, and changes sections. Placeholders are sourced from design mockups and need to be swapped for real product captures. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Move Summary Page from above Setup to below Setup in the NDM left nav, renumbering downstream NDM siblings. Editorial fixes: - Recast overview to avoid implying recent changes have a "health" - Clarify "Each top-level section on the page reports..." - Drop confusing "(up to 100)" parentheticals from Interface and Device performance sections - Bold UI labels (CPU, Memory) consistently in the default sort note - Remove inappropriate commas before "and"/"or" with two items - Match repo convention with "Further Reading" capitalization - Trim long alt text on Interface and Device performance images - Move filter bar image to follow both filter and time picker descriptions, since the image illustrates both Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The paragraph and image were captioning UI elements already visible in the surrounding network_health.png and hero summary_page.png images. Removing them tightens the Network health section without losing meaningful context. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Add Preview callout - Network Health: describe status panel and View Health link to Device Health - Issues: describe issue side panel; add issues-view screenshot - Interface performance: update screenshot, add device side panel ref, document three detail cards (Bandwidth, Errors, Discards) with app links, note Ask Bits entry point - Device performance: update screenshot, add device side panel ref, document CPU/Memory cards with app links - Traffic: rewrite for Sankey diagram (remove mismatched placeholder screenshot) - Changes: update screenshot to show full Changes view, add View all changes link - Add Device side panel section with screenshot - Add placeholder link for Device Health page (needs follow-up once doc exists) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
|
- Move health states table to Overview (applies page-wide, not just Network health) - Fold prerequisites into a Note in Overview - Fold filter/time range into intro of Page sections, remove standalone section - Trim device side panel to a single prose sentence Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…lth states to Page sections - Overview: prerequisites Note now precedes the main screenshot - Health states table moved from Overview to Page sections intro - Device side panel H2 removed; described inline in Interface health, cross-referenced from Device health - Remove unused device-side-panel.png Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…e Health page - Interface health: describe device side panel contents and Open Device Page button - Device health: cross-reference uses "device side panel" consistently - Issues: align with Device Health page terminology (Bits AI SRE), link out for details - Changes: describe filters/time inheritance, side panel on row click - Replace placeholder Device Health link with real path Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
What does this PR do? What is the motivation?
Fixes DOCS-13278
Adds a new documentation page for the Network Device Monitoring (NDM) Summary Page, a command-center view for network engineers that surfaces device and interface health, top issues, traffic, and recent configuration changes.
The page covers:
Also adds a
nextlinkfrom the NDM section index and a side nav entry at the top of the NDM section.Open items before merge:
Merge instructions
Merge readiness:
Additional notes