docs: document Export JSON flyout for dashboards (#5909)#6034
Open
florent-leborgne wants to merge 8 commits intomainfrom
Open
docs: document Export JSON flyout for dashboards (#5909)#6034florent-leborgne wants to merge 8 commits intomainfrom
florent-leborgne wants to merge 8 commits intomainfrom
Conversation
Adds documentation for the new Export JSON option in the dashboard Export menu, which exports the dashboard state as API-compatible JSON. Made-with: Cursor
Contributor
🔍 Preview links for changed docs |
Contributor
✅ Vale Linting ResultsNo 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. |
Co-authored-by: Florent LB <florent.leborgne@elastic.co>
Adds a reciprocal pointer in the NDJSON Export dashboards section so readers landing there discover the new JSON export option. Made-with: Cursor
Improves discoverability by surfacing the JSON export option at the start of the Export dashboards section. Made-with: Cursor
…ctions Promotes a single Export dashboards H2 with a comparison table that helps readers choose between NDJSON and JSON, then moves the existing NDJSON content and the new JSON content under H3 subsections with descriptive titles. Updates the cross-link in report-and-share.md to match the new H3 title. Made-with: Cursor
Adds a What it includes column to the format comparison table and removes the separate caveat sentence below it. The new column conveys the JSON export's single-dashboard scope and the supported-panels behavior without making the JSON export sound lossier than it is. Made-with: Cursor
Co-authored-by: Florent LB <florent.leborgne@elastic.co>
Turns NDJSON and JSON into anchor links to the corresponding H3 subsections, and moves the JSON applies_to badges after the link so the link text reads cleanly. Made-with: Cursor
Member
Author
|
Hey @nickpeihl I just tested this and it's a nice feature. Can you take a look at this doc update? Because there's also the legacy saved object export option documented there, I've been wondering how to correctly compare these 2 options and tried to rework that a little bit. Let me know what you think :) |
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.
Summary
Documents the new Export JSON flyout that ships in
elastic/kibana#255382for Stack 9.4 and serverless (technical preview), and reframes the existing dashboard export content so readers can choose between the two formats.Changes
explore-analyze/dashboards/sharing.md: Restructured theExport dashboardsH2 into an umbrella section with aFormat/Use it to/What it includescomparison table linking to two H3 subsections:Export as NDJSON saved objects— the existing Saved Objects workflow, content unchanged.Export as dashboards API-compatible JSON— new section documenting the toolbarExport>Export JSONflyout, theUnsupported properties were removedcallout, theOpen in ConsoleDev Tools handoff, and theDownload JSONaction. Taggedstack: preview 9.4/serverless: previewto match the technical preview status of the feature.Also expanded the page meta description so it reflects both export formats.
explore-analyze/report-and-share.md: Added anExport JSONbullet to theExport as a filelist, scoped tostack: preview 9.4/serverless: preview, with a cross-link to the new H3 in the dashboard sharing page.The existing NDJSON content is preserved verbatim under its new H3 so users on earlier versions still see the migration workflow they rely on.
Resolves
Closes #5909
Note on missing API links
The Kibana dashboards API is not yet publicly released. This PR therefore refers to the dashboards API in prose only, without hyperlinks. I'll add those in a later update.
Made with Cursor