docs: document four undocumented customer-facing changes - #11863
Conversation
- Note that cube.ts configuration files are no longer supported - Describe the dashboard "Published" version chip and its change summary - Add the Access chat history (ChatHistoryRead) custom role permission - Document that meta.cube.public in dbt controls generated cube/column visibility Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PU2hSNsbbt4zHjqyn8NU1x
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
Claude finished @keydunov's task in 2m 12s —— View job Docs review: sound changes, 1 medium + 3 low findings — 4 inline comments postedFull reviewTodo
Verification
No FindingsMedium —
Low — The check order in Low — The blank line before the new bullet makes the whole list render loose, changing spacing for every bullet above it. And Low — The section describes the header chip on an open published dashboard, while the rest of NotesNothing security-, performance-, or test-related applies — this is a docs-only change with no code paths touched. Three of the four claims describe enterprise-repo behavior I can't check from this checkout; they read plausibly and match the PR description, but the dbt |
| | `SchemaUpdate` | Edit data model | | ||
| | `SchemaUpdateDevBranches` | Edit data model on dev branches | | ||
| | `APMRead` | Access query history | | ||
| | `ChatHistoryRead` | Access chat history | |
There was a problem hiding this comment.
The new permission was added to the internal action catalog, but not to the user-facing Actions table above (lines 112–122), which is the table someone actually reads while building a deployment policy. Every other deployment-scoped action (DeploymentRead, SecretsManage, APMRead, DownloadData, …) appears in both.
The gap matters more than usual here because the grant semantics are privacy-relevant: per the PR description, ChatHistoryRead grants read access to all users' chat conversations and traces in the deployment — which is exactly the kind of thing a role author needs stated, and it's currently documented nowhere. Suggest a row in the Actions table, e.g.:
| Monitoring | Access chat history | View all users' chat conversations and traces in the deployment. Distinct from having an individual thread shared with you. |
Also worth confirming whether this action auto-bumps the Base Role to Developer — the <Tip> at line 130 says only DeploymentRead and DownloadData don't, so as written a Viewer-scoped "read chat history" role would silently become a Developer.
| <Note> | ||
|
|
||
| Configuration can only be defined in a `cube.js` or `cube.py` file. A `cube.ts` | ||
| file is not supported — if it's present without a `cube.js` file, Cube fails to | ||
| start with an error asking you to use `cube.js` or `cube.py` instead. | ||
|
|
||
| </Note> |
There was a problem hiding this comment.
Two things:
1. The condition is slightly off. In packages/cubejs-server/src/server/container.ts:255-282 the checks run in order cube.py → cube.js → cube.ts-error. So the error only fires when neither cube.js nor cube.py is present — with a cube.py alongside a cube.ts, Cube starts fine.
2. <Note> is reserved. docs-mintlify/CLAUDE.md says to use <Note> (gray) not <Info> (blue) specifically for plan-availability callouts, so that gating is visually distinct and scannable; <Info> is the catch-all. This isn't a plan-availability message.
| <Note> | |
| Configuration can only be defined in a `cube.js` or `cube.py` file. A `cube.ts` | |
| file is not supported — if it's present without a `cube.js` file, Cube fails to | |
| start with an error asking you to use `cube.js` or `cube.py` instead. | |
| </Note> | |
| <Info> | |
| Configuration can only be defined in a `cube.js` or `cube.py` file. A `cube.ts` | |
| file is not supported — if one is present and neither `cube.js` nor `cube.py` | |
| exists, Cube fails to start with an error asking you to use `cube.js` or | |
| `cube.py` instead. | |
| </Info> |
(Optionally fold this into the existing <Info> right above rather than stacking two callouts back to back.)
|
|
||
| - **Visibility** carries over from dbt: a model or column with `meta: { cube: | ||
| { public: false } }` in its dbt schema YAML is generated as non-public | ||
| (`public: false`) in Cube, and stays that way across re-pulls — unlike | ||
| editing the generated file directly, which the next pull overwrites. | ||
|
|
There was a problem hiding this comment.
Nit: the blank line before this bullet makes it the only loose item in an otherwise tight list — Markdown renders the whole list loose once any item is separated, so this changes the spacing of every bullet above it. Drop the blank line at 571 to keep it consistent with the rest of the list.
Also, readers copy-paste this into schema.yml, and meta: { cube: { public: false } } is JSON-flow YAML rather than the block form dbt schema files normally use. A two-line snippet would be more directly usable:
models:
- name: orders
meta:
cube:
public: falseI couldn't verify the meta.cube.public key against source — the dbt generation lives in cubejs-enterprise, not this repo — so please double-check the exact key path and that column-level meta is read the same way as model-level.
| ### Viewing what changed | ||
|
|
||
| An open dashboard shows a **Published** version chip in its header. Clicking | ||
| it shows which version is currently live, when and by whom it was published, | ||
| and a summary of what changed since the previously published version — | ||
| widgets added, updated, or removed, or the layout rearranged. |
There was a problem hiding this comment.
The section reads well, but it describes a dashboard surface (the header chip on an open published dashboard) while sitting on the workbooks page. The rest of ## Workbook versions is written from the workbook side and links out with [ref-dashboards] when it crosses over — worth doing the same here so readers know where to look:
| ### Viewing what changed | |
| An open dashboard shows a **Published** version chip in its header. Clicking | |
| it shows which version is currently live, when and by whom it was published, | |
| and a summary of what changed since the previously published version — | |
| widgets added, updated, or removed, or the layout rearranged. | |
| ### Viewing what changed | |
| An open [published dashboard][ref-dashboards] shows a **Published** version chip | |
| in its header. Clicking it shows which version is currently live, when and by | |
| whom it was published, and a summary of what changed since the previously | |
| published version — widgets added, updated, or removed, or the layout | |
| rearranged. | |
Optional: the docs elsewhere on this page and in custom-roles.mdx leave {/* TODO: screenshot — ... */} placeholders for UI that's hard to describe in prose. A chip in a header is a good candidate.
Check List
Description of Changes Made
Found via a routine audit cross-checking recent
cube-js/cubeandcubejs-enterprisecommits againstdocs-mintlifyfor undocumented customer-facing changes. These four were small enough to land as surgical edits:reference/configuration/config.mdx— notes thatcube.tsconfiguration files are no longer supported (feat(server): Remove support for cube.ts configuration file #11763); Cube now fails to start with an explicit error ifcube.tsis present without acube.js.docs/explore-analyze/workbooks/index.mdx— documents the dashboard header's Published version chip, which shows the live version and a change summary (added/updated/removed widgets, layout changes) versus the previous published version.admin/users-and-permissions/custom-roles.mdx— adds the newChatHistoryRead("Access chat history") deployment-scoped custom role permission, which grants read access to all users' chat conversations/traces in a deployment (distinct from being shared an individual thread).docs/integrations/dbt.mdx— documents thatmeta: { cube: { public: false } }in a dbt model/column's schema YAML now controls the generated cube/dimension's Cube visibility and survives re-pulls.🤖 Generated with Claude Code
https://claude.ai/code/session_01PU2hSNsbbt4zHjqyn8NU1x
Generated by Claude Code