Skip to content

docs: "dashboards as code" guide for programmatic dashboards (CUB-3521) - #11493

Draft
mngr wants to merge 1 commit into
masterfrom
gleb/cub-3521-dashboards-as-code
Draft

docs: "dashboards as code" guide for programmatic dashboards (CUB-3521)#11493
mngr wants to merge 1 commit into
masterfrom
gleb/cub-3521-dashboards-as-code

Conversation

@mngr

@mngr mngr commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Dashboards as code guide (CUB-3521)

Adds a new guide documenting the runtime-owned "dashboards as code" model: dashboards and charts defined as versioned YAML in a Cube project's dashboards/ directory, deployed with the data model via Git, and rendered read-only in the workspace.

New page: docs-mintlify/docs/explore-analyze/dashboards/dashboards-as-code.mdx, added to the Dashboards nav group, with a discovery cross-link from the dashboards index.

Covers

  • When to use it, how it works (folders from directory structure, read-only, live queries)
  • The two file kinds (cube.dev/dashboard/v1 + cube.dev/chart/v1), widget shapes and types, tabbed widgets
  • Chart publicId identity, the visualization spec, a complete example, deploying via Git, build-time validation rules

Verified against the implementation

Every fact was checked against source, not invented:

  • File format / apiVersion / folder derivation / validation → cube-runtime DashboardsConfigService.ts + types.ts
  • Widget shapes (type: CHART|TEXT|FILTER|TIME_GRAIN|AI_SUMMARY|TABS_CONTAINER, position {x,y,w,h}, chart: <publicId>, tabs) → the console read adapter + the dashboard-asset-yaml serializer
  • TEXT widget field is config.content; example publicIds are valid 12-char; CUBE_CLOUD_DASHBOARDS_CONFIG_PATH default confirmed
  • All internal links + the #dashboard-slug anchor resolve

⚠️ Draft — do not merge until the feature ships

This documents a preview capability. The runtime-owned model is still behind the dark useRuntimeDashboards flag (console side in cubejs-enterprise PR #13550, pending product sign-off; cube-runtime side on a branch). The page carries a preview <Note>. Keep this as draft until the feature is generally enabled, then flip to ready-for-review.

Linear: CUB-3521

@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cubed3 🟢 Ready View Preview Aug 6, 2026, 4:13 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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.

1 participant