Skip to content

docs: document subscribing to scheduled-refresh notifications#11302

Merged
mngr merged 3 commits into
masterfrom
docs/scheduled-refresh-subscribe
Jul 20, 2026
Merged

docs: document subscribing to scheduled-refresh notifications#11302
mngr merged 3 commits into
masterfrom
docs/scheduled-refresh-subscribe

Conversation

@mngr

@mngr mngr commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Description

Documents that the scheduled refreshes sidebar is now available on published dashboards, and that anyone who can view a dashboard can subscribe or unsubscribe themselves to a schedule's email notifications — without an editor adding them as a recipient.

Changes to docs-mintlify/docs/explore-analyze/:

  • scheduled-refreshes.mdx
    • Noted in the intro <Info> box that viewing schedules and subscribing to notifications only needs view access (setting schedules up still needs Edit/Manage).
    • Expanded "Accessing scheduled refreshes" to cover opening the sidebar from a published dashboard, and what each permission level can do there (Edit/Manage → full sidebar; View only → read-only list with a subscribe toggle).
    • New "Subscribing to notifications" section: how the per-schedule subscribe/unsubscribe toggle works, that it adds/removes you from the schedule's email recipients and takes effect on the next run, and when the toggle appears (email-channel schedules with notifications on — Slack/disabled schedules have nothing to subscribe to). Also notes that if an editor switches a schedule to Slack its existing subscriptions are cancelled, and you can subscribe again if it is later switched back to email.
  • notifications.mdx
    • Added a <Tip> in the Email notifications section cross-linking the self-subscribe flow.

Notes

Docs-only change. The <Tip>/<Info>/<Warning> components and all anchor/link targets were verified against existing usage on these pages.

Recreated from the upstream repo (supersedes the fork-based #11286, which couldn't run the review-with-tracking check). Rebased onto current master, on top of the merged #11246 (duplicating schedules) — the Duplicating and Subscribing sections coexist on scheduled-refreshes.mdx.

@mngr
mngr requested a review from keydunov as a code owner July 20, 2026 16:22
@github-actions github-actions Bot added the pr:community Contribution from Cube.js community members. label Jul 20, 2026
@claude

claude Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mngr's task in 34s —— View job


Code Review

Docs-only change. Read both files against origin/master and verified anchors, link definitions, and Mintlify component usage.

Verdict: LGTM — no blocking issues.

Details

Checks performed

  • Read PR diff and both changed files in full
  • Verified #subscribing-to-notifications anchor resolves to the new H2 in scheduled-refreshes.mdx
  • Verified [ref-subscribe] and [ref-notifications] link definitions exist and are used
  • Confirmed the removed duplicate [ref-scheduled-refreshes] definition (previously defined twice) is a genuine cleanup, not a lost link
  • Checked <Tip> / <Info> / <Warning> component usage matches conventions on these pages
  • Confirmed coexistence with the recently merged "Duplicating a schedule" section — both sit under ## peers with no anchor collision

Notes / minor observations (non-blocking)

  • notifications.mdx:94 — nice catch removing the duplicated [ref-scheduled-refreshes] reference definition; the earlier one at :92 is the one in use.
  • scheduled-refreshes.mdx:9 — the sentence "Anyone who can view the dashboard can open the sidebar…" reads slightly at odds with the surrounding "Users need at least Explorer role and Edit/Manage" clause. It's technically consistent (viewing ≠ setting up), but a reader skimming the <Info> box could momentarily see a contradiction. Optional: split into two sentences or lead with "To set up schedules, …" to make the two audiences distinct. Not required to merge.
  • Copy in the new "Subscribing to notifications" section is clear and matches the tone of the surrounding sections. The "Slack cancels subscriptions; re-subscribe if switched back" edge case is a good inclusion.

Not applicable to this PR: security, performance, tests — pure documentation.

• Branch: `docs/scheduled-refresh-subscribe`

@mintlify

mintlify Bot commented Jul 20, 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 Jul 20, 2026, 4:23 PM

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

@mngr
mngr force-pushed the docs/scheduled-refresh-subscribe branch from 81b88fa to b59fb0c Compare July 20, 2026 16:27
@claude

claude Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mngr's task in 29s —— View job


Code Review (re-run)

Docs-only change. Re-checked the diff against origin/master after the sync — no substantive changes since the prior review (same 3 commits, same content).

Verdict: LGTM — no blocking issues.

Details
  • Re-read PR diff against origin/master
  • Verified #subscribing-to-notifications anchor still resolves to the new H2 in scheduled-refreshes.mdx
  • Verified [ref-subscribe] / [ref-notifications] link definitions present and used
  • Confirmed Mintlify <Tip> / <Info> / <Warning> usage matches page conventions
  • Confirmed peaceful coexistence with the merged "Duplicating a schedule" section (no anchor collision)

Minor, non-blocking (unchanged from prior review):

  • scheduled-refreshes.mdx:9 — the added sentence "Anyone who can view the dashboard can open the sidebar…" reads slightly at odds with the surrounding "Users need at least Explorer role and Edit or Manage permission" clause in the same <Info> box. Technically consistent (viewing ≠ setting up), but a skim reader could momentarily see a contradiction. Optional split, e.g. lead with "To set up schedules, …" then a separate sentence for viewers.

Not applicable: security, performance, tests — pure documentation.

• Branch: `docs/scheduled-refresh-subscribe`

@mngr
mngr merged commit fb4962b into master Jul 20, 2026
9 checks passed
@mngr
mngr deleted the docs/scheduled-refresh-subscribe branch July 20, 2026 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:community Contribution from Cube.js community members.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant