Skip to content

docs: describe the outcome messages after a manual pre-aggregation refresh - #11773

Open
keydunov wants to merge 1 commit into
masterfrom
claude/gallant-ramanujan-bpi1e5
Open

docs: describe the outcome messages after a manual pre-aggregation refresh#11773
keydunov wants to merge 1 commit into
masterfrom
claude/gallant-ramanujan-bpi1e5

Conversation

@keydunov

@keydunov keydunov commented Sep 5, 2026

Copy link
Copy Markdown
Member

Check List

  • Docs have been added / updated if required
  • Tests have been run in packages where changes have been made if available
  • Linter has been run for changed code
  • Tests for the changes have been added if not covered yet

Description of Changes Made

cubejs-enterprise#14657 (CUB-3373) changed what a manual refresh reports: instead of
always claiming "Refreshed successfully", Cube now distinguishes a confirmed rebuild
from one it can't yet confirm ("Refresh requested") or one still running past a few
minutes. This adds a short paragraph to the "Result freshness and provenance" section
of the querying-data page describing those three outcomes, since the existing text
only covered the passive freshness/pre-aggregation indicators, not what a manual
Refresh / Refresh all / Run all reports.

🤖 Generated with Claude Code

https://claude.ai/code/session_011oxbph2zZPPPv8NCMRofH4


Generated by Claude Code

…fresh

A chart's Refresh, a dashboard's Refresh all, and a workbook's Run all now
report whether a pre-aggregation rebuild actually completed, was only
requested, or is still running — rather than assuming success.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011oxbph2zZPPPv8NCMRofH4
@mintlify

mintlify Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
cubed3 🟢 Ready View Preview Sep 5, 2026, 12:15 AM

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

@claude

claude Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

Claude finished @keydunov's task in 57s —— View job


Review: docs-only change, looks accurate — 0 high, 0 medium, 3 low (1 inline comment)

Full review

Todos

  • Gather context (diff, target file, surrounding docs conventions)
  • Classify request — code review
  • Check CLAUDE.md / docs-mintlify conventions
  • Review the change
  • Check for stale/duplicate prior review threads
  • Post feedback

Summary

The PR adds one paragraph to the "Result freshness and provenance" section of docs-mintlify/docs/explore-analyze/workbooks/querying-data.mdx, describing the three outcomes of a manual pre-aggregation refresh. It's the right site (/docs-mintlify, not the deprecated /docs), the right page and section, it edits an existing page rather than adding one, and it needs no docs.json navigation change. Nothing to flag on security, performance, or tests — this touches no code paths.

Findings (all low)

# Location Issue
1 querying-data.mdx:337 One ~90-word sentence with three outcomes joined by a colon; the section otherwise uses bullets for enumerations. Suggested a bulleted rewrite inline.
2 querying-data.mdx:337 The third outcome is paraphrased ("a message noting the rebuild is still running") while the other two are quoted verbatim in bold — inconsistent, and a reader can't match it against the UI.
3 querying-data.mdx:337 Refresh all and Run all aren't documented anywhere else in the Cube Cloud docs (only Excel/Sheets integration pages use "Refresh all", for a different control). dashboards/index.mdx:27 deep-links into this section, so readers may arrive without context for those control names.

All three are folded into a single inline comment with a suggestion block, since they sit on the same line.

What I did not do

  • Did not run yarn lint or the Mintlify dev server — the change is prose-only inside an existing .mdx paragraph, with no new components, frontmatter, or links to validate beyond the existing root-relative link style, which the line follows.
  • No prior Claude review threads existed on this PR, so nothing to resolve or dedupe against.
· branch [`claude/gallant-ramanujan-bpi1e5`](https://github.com/cube-js/cube/tree/claude/gallant-ramanujan-bpi1e5)

- **Freshness** — a leaf icon shows how recently the underlying data was refreshed. Hover over it to see the last refresh time (for example, "Refreshed 5 minutes ago"); its color shifts as the data ages, so you can tell fresh from stale results at a glance. If the refresh time can't be determined, the leaf turns gray with a "Data age unknown" label. When you have access to [Query History](/admin/monitoring/query-history), clicking the leaf opens the underlying request for that result.
- **Pre-aggregation** — for those same users, a lightning-bolt icon appears next to the leaf with a "Served from a pre-aggregation" label whenever the result was served from a [pre-aggregation](/docs/pre-aggregations). If no icon is shown, the query ran directly against your data source.

Manually refreshing a result served from a pre-aggregation (a chart's **Refresh**, a dashboard's **Refresh all**, or a workbook's **Run all**) reports what actually happened, since a pre-aggregation rebuild can take longer than the request itself waits for: **Refreshed successfully** once the rebuild is confirmed complete, **Refresh requested** when Cube can't yet confirm whether a rebuild finished, or a message noting the rebuild is still running if it takes more than a few minutes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a single ~90-word sentence that packs the trigger controls, the why, and three outcomes behind one colon. The rest of this section uses bullets for exactly this kind of enumeration, so splitting it reads better and stays scannable:

Suggested change
Manually refreshing a result served from a pre-aggregation (a chart's **Refresh**, a dashboard's **Refresh all**, or a workbook's **Run all**) reports what actually happened, since a pre-aggregation rebuild can take longer than the request itself waits for: **Refreshed successfully** once the rebuild is confirmed complete, **Refresh requested** when Cube can't yet confirm whether a rebuild finished, or a message noting the rebuild is still running if it takes more than a few minutes.
Manually refreshing a result served from a pre-aggregation a chart's **Refresh**, a dashboard's **Refresh all**, or a workbook's **Run all**reports what actually happened, since a pre-aggregation rebuild can take longer than the request waits for:
- **Refreshed successfully** — the rebuild is confirmed complete.
- **Refresh requested** — Cube can't yet confirm whether the rebuild finished.
- If the rebuild is still running after a few minutes, Cube reports that it's still in progress.

Two smaller things while you're in here:

  • The third outcome is the only one whose message isn't quoted verbatim ("a message noting the rebuild is still running"). If that string is stable in cubejs-enterprise#14657, quoting it in bold like the other two makes the paragraph consistent and lets a reader match what they see in the UI against the docs.
  • Refresh all and Run all aren't described anywhere else in the Cube Cloud docs (only in the Excel/Sheets integration pages, for a different control). Readers hitting this paragraph via the #result-freshness-and-provenance deep link from dashboards/index.mdx:27 may not know those controls. Not blocking, but a short "these controls live at …" clause, or documenting them on the dashboards page, would close the gap.

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.

2 participants