Skip to content

docs(dashboards): update saved dashboard contents, save flow, and Sav… - #159

Open
vaishaldsouza wants to merge 1 commit into
OpsiMate:mainfrom
vaishaldsouza:docs/saved-dashboards-save-flow
Open

vaishaldsouza wants to merge 1 commit into
OpsiMate:mainfrom
vaishaldsouza:docs/saved-dashboards-save-flow

Conversation

@vaishaldsouza

@vaishaldsouza vaishaldsouza commented Oct 26, 2026 •

Copy link
Copy Markdown

Issue Reference

Closes OpsiMate/OpsiMate#1332


What Was Changed

Updated opsimate-docs/docs/dashboards/saved-dashboards.md:

  • Replaced the "A saved dashboard includes" list with what a save actually stores: name and description, filters and search query, visible columns/order/widths, group by, time range (presets stay rolling, only a custom range keeps fixed dates), and the Split by owner and Severity colors toggles. Added a note that tags are not part of a save (managed per row on the Dashboards page) and that Expand rows is a per-browser setting.
  • Rewrote How to Save a Dashboard as short steps (New Dashboard, opens as a Draft, set up the view, name it, click Save), plus a note covering the Draft badge, when the Save icon appears, renaming, the settings gear, and the unsaved-changes prompt.
  • Added a Save as new dashboard section: what it does, the " (copy)" name suggestion, the duplicate/empty-name rule, and that the original keeps its last saved version.
  • Added a short Dashboards page section: search, filter by tag, add/remove tags per row, and favourites (stored in the browser, not on the server).

The existing screenshot is kept. No length limits or time range validation are mentioned, since those are not enforced yet (#1135).


Why Was It Changed

The page listed tags as part of a save and omitted time range, group by, column order/widths and the toolbar toggles. The save steps skipped the Draft badge, the conditional Save icon, rename-to-save, the settings gear, and Save as new dashboard entirely, so readers could not tell what a save would keep or how to copy a dashboard safely.


Screenshots

Screenshot 2026-10-26 122428 Screenshot 2026-10-26 122505

Additional Context (Optional)

npm run build passes with no errors or broken links. Previewed locally with npm start.

Summary by CodeRabbit

  • Documentation
    • Expanded the saved-dashboard guide with details on what is saved, including filters, layout, grouping, and time range.
    • Clarified that preset time ranges stay rolling, custom ranges keep fixed dates, and tags and the Expand rows toggle are not saved.
    • Added guidance for creating, editing, renaming, copying, and saving dashboards, handling unsaved changes, and using search, tags, and favorites.

@mintlify

mintlify Bot commented Oct 26, 2026

Copy link
Copy Markdown

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit c3c5b20.

Approve preview

@vercel

vercel Bot commented Oct 26, 2026

Copy link
Copy Markdown

@vaishaldsouza is attempting to deploy a commit to the idan lodzki's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 6fa12a9 and c3c5b20.

Files selected for processing: 1
  • opsimate-docs/docs/dashboards/saved-dashboards.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The saved-dashboard documentation now describes which dashboard state is saved, how to create and save drafts, how to save a copy, and which search, tag, and favorite controls are available on the Dashboards page.

Changes: Saved dashboard documentation

Layer / File(s) Summary
Saved dashboard state
opsimate-docs/docs/dashboards/saved-dashboards.md
The documentation lists saved dashboard details and view settings, distinguishes rolling preset ranges from fixed custom dates, and states that tags and Expand rows are not saved.
Draft, save, and copy workflows
opsimate-docs/docs/dashboards/saved-dashboards.md
The instructions cover creating drafts, saving and renaming dashboards, settings, unsaved-change prompts, and saving the current view as a copy.
Dashboards page controls
opsimate-docs/docs/dashboards/saved-dashboards.md
The documentation describes search, tag filtering and management, and browser-stored favorites.

Assessment against linked issues

Objective Addressed Explanation
Document saved dashboard contents, draft and save behavior, saving a copy, and Dashboards page controls [#1332] ✅

Suggested reviewers: idanlodzki

Priority: Low

Change: Other

Merge Risk: Minimal · up to c3c5b

No merge-blocking risk remains from this documentation-only change.

Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Saved Dashboards: list what a dashboard stores, and document Save, Save as new and Draft

1 participant