docs: rework import dashboards for the Dashboards API workflow and move it under Manage dashboards (#7166)#7185
Open
florent-leborgne wants to merge 12 commits into
Open
docs: rework import dashboards for the Dashboards API workflow and move it under Manage dashboards (#7166)#7185florent-leborgne wants to merge 12 commits into
florent-leborgne wants to merge 12 commits into
Conversation
Split the import page into an applies-switch mirroring the Export JSON section: a 9.4+/serverless tab that routes to copy-to-space and the Dashboards API / manage-as-code, and a 9.0-9.3 tab that keeps the Saved Objects NDJSON import. Move import and sharing under Managing dashboards. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
…oards API Rework the intro to present why you would import a dashboard, and reframe the 9.4+ tab so the Dashboards API is the primary import flow. Demote copy-to-space to a secondary aside for same-deployment moves. Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the version-based applies-switch with a tab set named by the exported format (JSON via Dashboards API, NDJSON via Saved Objects). Reframe the intro around how the dashboard was exported, give each tab clear prerequisites, and lean on the export page for the concepts. Co-authored-by: Cursor <cursoragent@cursor.com>
…pace Point to the import saved objects API from the NDJSON tab and the copy saved objects to space API from the copy note, so every UI path also shows its programmatic form. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.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
2 participants
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.
Summary
This PR addresses #7166 with the following changes:
explore-analyze/dashboards/import-dashboards.md: restructured into anapplies-switchmirroring the Export JSON section of the sharing page. The 9.4+/serverless tab routes by use case (copy to space for same-deployment moves; the Dashboards API and manage-as-code for cross-deployment or code-based workflows) and demotes NDJSON import to a "still available, not recommended" note; the 9.0–9.3 tab keeps the current Saved Objects NDJSON import steps.explore-analyze/toc.yml: movedimport-dashboards.mdandsharing.mdunder Managing dashboards (out of Build a dashboard and the top level).explore-analyze/dashboards.md: updated the "Import a dashboard" description to match the new framing.Resolves
Closes #7166
Depends on
manage-dashboards-as-code.mdand nests it under Managing dashboards). This PR links to that page and both edit the same dashboards TOC block, so:manage-dashboards-as-code.mdwon't resolve and thetoc.ymlchange will conflict.main, resolve the TOC block so Managing dashboards listssharing.md,import-dashboards.md, andmanage-dashboards-as-code.md, and confirm the link resolves.Notes for reviewers
toc.ymldoesn't change their URLs (the URL derives from the file path, which is unchanged), so theredirects.ymlentries the issue anticipated aren't needed.building.mdalready drops the old "import ... exported from another instance" bullet in docs: add manage dashboards as code overview (#5448) #7029, so it isn't touched here.applies_to: stack: ga / serverless: gaat the page level; the version split lives in theapplies-switch, matching the sharing page.Screenshots to add or update
explore-analyze/dashboards/import-dashboards.md— the existing NDJSON import screenshot (kibana-dashboard-import-saved-object.png) now sits inside the 9.0–9.3 tab. It's still accurate for that path; no update needed unless the Saved Objects import UI changes.