Skip to content

docs: clarify HSM delivery dashboard setup and sharing steps#647

Open
SangeetaMishr wants to merge 2 commits into
mainfrom
docs/hsm-delivery-dashboard-update
Open

docs: clarify HSM delivery dashboard setup and sharing steps#647
SangeetaMishr wants to merge 2 commits into
mainfrom
docs/hsm-delivery-dashboard-update

Conversation

@SangeetaMishr

@SangeetaMishr SangeetaMishr commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

Addresses #332

This is a partial fix - the issue also asks to change the preview dashboard URL so it can be opened by all, but I don't have access to the live Looker Studio report's sharing settings to change them directly. Instead, this documents the sharing step needed so report owners know to fix access themselves.

Changes:

  • Added a note clarifying that the "select Contacts table" step in Part 1 is only used to open the BigQuery query editor in the right dataset context - the query itself only reads from the messages table. Kept the step as-is per feedback, just added the clarifying note rather than removing it.
  • Added a note in Part 2 explaining that the linked dashboard is a preview URL tied to the report owner's account, and that before sharing your own copy with your team, you need to set Looker Studio sharing to "Anyone with the link" → Viewer so teammates outside your account can open it.

Open question

The issue also mentions "remove the contact_collection table" from the query, but the current query only selects from messages - there's no contact_collection (or similar) table referenced anywhere in it. If there's a specific query change intended here, please comment and I'll follow up in this PR.

Verification

Ran yarn build locally (with dummy Algolia env vars matching CI) to confirm the docs site still builds cleanly with this change.

Test plan

  • Docs site renders the new notes correctly
  • Reviewer/issue reporter confirms whether further query changes are needed

Summary by CodeRabbit

  • Documentation
    • Added clarifying setup notes for the HSM Delivery Dashboard.
    • Explained the correct dataset context for opening the query editor.
    • Added guidance on sharing the dashboard preview link so teammates can access it.

Add a note that the Contacts table step is only used to open the
query editor in the right dataset (the query itself only reads
messages), and a note on setting Looker Studio sharing to "Anyone
with the link" so teammates outside the owner's account can open the
dashboard.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

@github-actions github-actions Bot temporarily deployed to pull request July 6, 2026 10:39 Inactive
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@SangeetaMishr, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 51 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 06afd9c1-de62-4bc3-a061-662c570d46f1

📥 Commits

Reviewing files that changed from the base of the PR and between 32bf043 and 1f01e07.

📒 Files selected for processing (1)
  • docs/4. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM Delivery Dashboard.md
📝 Walkthrough

Walkthrough

This change updates the HSM Delivery Dashboard setup documentation with two added notes. One clarifies that selecting Contacts is only to open the BigQuery editor in the correct dataset context, while the actual query reads from the messages table. The other explains that the Looker Studio preview link is tied to the report owner's account and must be re-shared for teammates outside that account to access it.

Changes

File Change Summary
docs/4. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM Delivery Dashboard.md Added two "Note" clarifications regarding BigQuery dataset context and Looker Studio link sharing

Sequence Diagram(s)

Not applicable; this change is documentation-only.

Estimated code review effort: Low

Related PRs: None identified.

Suggested labels: documentation

Suggested reviewers: None identified.

Poem

A rabbit hops through docs so neat,
Adding notes to guide each feat,
BigQuery's context, clear as day,
Looker links now shared the right way,
Small hops, big clarity — hooray!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the doc changes: clarifying dashboard setup and sharing steps.
Description check ✅ Passed The description is directly related to the documentation updates and the issue it addresses.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

…otes

Add the read-time/level/Last Updated header used elsewhere in the
docs (Last Updated: July 2026), and drop backticks from the two notes
added in this PR for consistency with review feedback.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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