Skip to content

Restructure dashboard sharing page to include export and embed info#5592

Draft
florent-leborgne wants to merge 1 commit intomainfrom
fix/5590-share-export-dashboards
Draft

Restructure dashboard sharing page to include export and embed info#5592
florent-leborgne wants to merge 1 commit intomainfrom
fix/5590-share-export-dashboards

Conversation

@florent-leborgne
Copy link
Member

Closes #5590

Summary

The Share dashboards page only covered link sharing and NDJSON export. Users couldn't find information about PDF/PNG export, embedding, or CSV download — all of which existed only on the general Reporting and sharing page without clear cross-referencing.

Changes

explore-analyze/dashboards/sharing.md (main change):

  • Renamed the page from "Sharing dashboards" to "Share and export dashboards"
  • Added a table-of-contents-style intro listing all available options
  • Restructured into clear, self-contained sections:
    1. Manage access permissions — existing content, kept with snippet include
    2. Share with a link — now self-contained with time range options (relative vs absolute), tips, and anonymous access info (previously users had to navigate to the reporting page)
    3. Embed in a webpage (serverless: unavailable) — new section with step-by-step instructions and embed options (Top menu, Query, Time filter, Filter bar); includes a TODO placeholder for a screenshot
    4. Export as PDF or PNG (serverless: unavailable) — new section covering PDF/PNG report generation, print format option, and scheduling; links to the reporting page for advanced configuration and limitations
    5. Download visualization data as CSV — new section explaining how to download Lens visualization data as CSV
    6. Export dashboard configuration — renamed from "Export dashboards" for clarity; same NDJSON content
  • Each section includes correct applies_to availability markers (serverless unavailable for embed, PDF, PNG)
  • Updated frontmatter: added navigation_title, updated description

explore-analyze/report-and-share.md:

  • Added cross-reference to the dashboard sharing page from the "Export as a file" section
  • Added cross-reference to the dashboard embed instructions from the "Embed code" bullet

explore-analyze/dashboards.md:

  • Updated the link text and description to match the new page title

Verified against the Kibana codebase

All UI labels, options, and behavior were verified against the Kibana source:

  • Share dialog tabs: Link and Embed (from share_tabs.tsx)
  • Embed checkboxes and defaults (from show_share_modal.tsx and _dashboard_app_strings.ts)
  • Export options: PDF with "Print format" switch, PNG (from pdf_export_config.tsx, share_options_utils.ts)
  • CSV download from Lens (from csv_download_provider.tsx)
  • Serverless restrictions: embed filtered out in share_menu_registry.ts, PDF/PNG disabled by default in config_schema.ts

Test plan

  • Preview the restructured sharing page and verify it reads well
  • Verify all internal links resolve correctly
  • Verify the cross-references from report-and-share.md work
  • Confirm applies_to markers render correctly for serverless vs stack
  • Add screenshot for the embed tab (marked as TODO)

Made with Cursor

Closes #5590

Users looking for export (PDF/PNG) and embed instructions on the dashboard
sharing page couldn't find them. Restructures the page into clear sections
covering permissions, link sharing, embedding, PDF/PNG export, CSV download,
and NDJSON export — with correct serverless availability markers.

Made-with: Cursor
@github-actions
Copy link
Contributor

Vale Linting Results

Summary: 2 suggestions found

💡 Suggestions (2)
File Line Rule Message
explore-analyze/dashboards/sharing.md 93 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
explore-analyze/dashboards/sharing.md 132 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.

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.

@github-actions
Copy link
Contributor

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.

[Dashboards]: Add export information to the sharing page

1 participant