docs: document PNG/PDF embed export and add an Alerts page - #11620
docs: document PNG/PDF embed export and add an Alerts page#11620keydunov wants to merge 2 commits into
Conversation
allowExport=true now gates PNG and PDF chart downloads in addition to CSV in embedded dashboards (CUB-4065).
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @keydunov's task in 1m 27s —— View job Review complete — docs-only change, direction is right. 1 high, 2 medium, 1 low (2 inline comments posted)Full review
Findings1. High — heading rename breaks an existing in-repo anchor link (
2. Medium — The 3. Medium — inconsistent with the canonical PNG/PDF section (
4. Low — scope of The text says "each chart widget's ⋮ menu", but the canonical section also documents a whole-dashboard ⋯ → Download as PNG / PDF. Does What's good
Not applicableSecurity, performance, and test-coverage checks from the review checklist don't apply — this is a documentation-only change with no code, queries, or executable surface. No build/lint run: the change is a single |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| dashboard. | ||
|
|
||
| ## Allow CSV export | ||
| ## Allow CSV, PNG, and PDF export |
There was a problem hiding this comment.
Renaming this heading changes the generated anchor from #allow-csv-export to #allow-csv-png-and-pdf-export, which breaks the existing in-repo link at docs-mintlify/embedding/iframe/events.mdx:214:
export](/embedding/iframe/dashboards#allow-csv-export)). The event fires when a
docs-mintlify/CLAUDE.md also says not to rename URL anchors — use Mintlify's explicit anchor syntax to keep inbound links working:
| ## Allow CSV, PNG, and PDF export | |
| ## Allow CSV, PNG, and PDF export {#allow-csv-export} |
(The link text in events.mdx — "Dashboards → Allow CSV export" — should still be updated to match the new heading.) Fix this →
| When enabled, each chart widget's ⋮ menu shows **Download as CSV**, **Download | ||
| as PNG**, and **Download as PDF** actions. The CSV is generated client-side from | ||
| the data already loaded into the widget, so no additional query is issued. The | ||
| PNG and PDF exports are rendered server-side and reflect the viewer's theme and | ||
| locale. The parameter is opt-in — omit it (the default) to keep the download | ||
| actions hidden. |
There was a problem hiding this comment.
The PNG/PDF description here doesn't line up with the existing non-embedded description at docs-mintlify/docs/explore-analyze/dashboards/index.mdx:81-86, which says:
- exports are server-rendered snapshots that can take up to a couple of minutes for large dashboards;
- the filter and time-grain selections currently applied in the browser are carried into the export.
Neither of those (especially the latency, which matters a lot for an embedded viewer clicking a menu item) is mentioned here, while "reflect the viewer's theme and locale" appears in neither place. Two things worth confirming/tightening:
- Is the theme/locale claim actually backed by the CUB-4065 implementation? If it is, it'd be good in the canonical section too; if it's inferred, drop it.
- Rather than restating server-render mechanics (CLAUDE.md: "say it once"), consider a one-liner plus a link to the canonical section:
| When enabled, each chart widget's ⋮ menu shows **Download as CSV**, **Download | |
| as PNG**, and **Download as PDF** actions. The CSV is generated client-side from | |
| the data already loaded into the widget, so no additional query is issued. The | |
| PNG and PDF exports are rendered server-side and reflect the viewer's theme and | |
| locale. The parameter is opt-in — omit it (the default) to keep the download | |
| actions hidden. | |
| When enabled, each chart widget's ⋮ menu shows **Download as CSV**, **Download | |
| as PNG**, and **Download as PDF** actions. The CSV is generated client-side from | |
| the data already loaded into the widget, so no additional query is issued. PNG | |
| and PDF are [server-rendered snapshots](/docs/explore-analyze/dashboards#download-as-png-or-pdf) | |
| and can take longer to produce. The parameter is opt-in — omit it (the default) | |
| to keep the download actions hidden. |
Also: does allowExport=true gate only the per-widget ⋮ menu, or does it also expose the whole-dashboard ⋯ → Download as PNG/PDF action described in that section? The current wording ("each chart widget's ⋮ menu") implies widget-only — worth stating explicitly either way, since that's the first question a reader will have.
Alerts (email notifications for API outages, database timeouts, and pre-aggregation build failures/completions) recently gained a permanent home in the account-level Admin panel (CUB-3926), but the feature itself had no docs page yet.
keydunov
changed the title
|
Claude finished @keydunov's task in 2m 19s —— View job Re-review of new commit
|
|
|
||
| <Note> | ||
|
|
||
| Available on the [Starter plan and above](https://cube.dev/pricing). |
There was a problem hiding this comment.
Two things on this callout.
Phrasing — docs-mintlify/CLAUDE.md fixes the wording for multi-tier availability: ✅ "Available on [Starter and above plans]". Every other page follows it (admin/monitoring/performance.mdx:13, admin/monitoring/usage-analytics.mdx:18, admin/account-billing/budgets.mdx:12 all use "Premium and above plans"). "the Starter plan and above" is a new variant.
| Available on the [Starter plan and above](https://cube.dev/pricing). | |
| Available on [Starter and above plans](https://cube.dev/pricing). |
The claim itself — worth double-checking Starter is right. Every sibling page in this group is Premium+ or Enterprise (performance Premium+, usage-analytics Premium+, audit-log Enterprise, monitoring-integrations Enterprise add-on), so Starter would be the outlier here. If Alerts really is available on Free too, the callout should be dropped entirely rather than named at the lowest paid tier. Fix this →
| | API outages | A deployment's API becomes unreachable. | | ||
| | Database response timeouts | A query to the connected data source times out. | | ||
| | Pre-aggregation build failures | A [pre-aggregation build](/admin/monitoring/pre-aggregations) fails. | | ||
| | Build completed | A deployment build finishes. | |
There was a problem hiding this comment.
This row conflicts with the page intro. Line 7 says alerts fire when "a pre-aggregation build fails or completes", which reads as pre-aggregation build completion — but the table defines Build completed as "A deployment build finishes", a different thing entirely (deployment/model build vs. pre-agg build).
One of the two is wrong, and a reader picking event types can't tell which. If it's a deployment build, the intro sentence should say so:
Alerts send email notifications when a deployment has an API outage, a database response timeout, a pre-aggregation build fails, or a deployment build completes.
Also, the description frontmatter (line 3) lists only outages/timeouts/pre-agg failures and omits this fourth type. Fix this →
2 participants
Check List
Description of Changes Made
Two undocumented customer-facing changes found via a routine audit cross-checking recent
cubejs-enterprisechanges against docs-mintlify coverage:allowExport=trueon embedded dashboards previously gated only a Download as CSV action. As of CUB-4065 (cubejs-enterprise #14290), it also gates Download as PNG and Download as PDF. Updated the "Allow CSV export" section of the embedding docs accordingly.