docs: "dashboards as code" guide for programmatic dashboards (CUB-3521) - #11493
Draft
mngr wants to merge 1 commit into
Draft
docs: "dashboards as code" guide for programmatic dashboards (CUB-3521)#11493mngr wants to merge 1 commit into
mngr wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
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.
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
cube.dev/dashboard/v1+cube.dev/chart/v1), widget shapes and types, tabbed widgetspublicIdidentity, the visualization spec, a complete example, deploying via Git, build-time validation rulesVerified against the implementation
Every fact was checked against source, not invented:
apiVersion/ folder derivation / validation → cube-runtimeDashboardsConfigService.ts+types.tstype: CHART|TEXT|FILTER|TIME_GRAIN|AI_SUMMARY|TABS_CONTAINER,position {x,y,w,h},chart: <publicId>, tabs) → the console read adapter + thedashboard-asset-yamlserializerTEXTwidget field isconfig.content; examplepublicIds are valid 12-char;CUBE_CLOUD_DASHBOARDS_CONFIG_PATHdefault confirmed#dashboard-sluganchor resolveThis documents a preview capability. The runtime-owned model is still behind the dark
useRuntimeDashboardsflag (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