docs: clarify HSM delivery dashboard setup and sharing steps#647
docs: clarify HSM delivery dashboard setup and sharing steps#647SangeetaMishr wants to merge 3 commits into
Conversation
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>
|
🚀 Deployed on https://deploy-preview-647--glific-docs.netlify.app |
📝 WalkthroughWalkthroughUpdated the HSM Delivery Dashboard setup guide with a refreshed status block showing the July 2026 update date. Added a BigQuery note explaining that selecting 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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. Comment |
…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>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/4`. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM
Delivery Dashboard.md:
- Line 4: Update the read-time label in the documentation from “4 minutes read”
to the grammatically correct “4-minute read” or “4 minutes to read,” while
preserving the existing formatting.
- Around line 1-9: Prepend a top-level Markdown heading before the existing
status table in the HSM Delivery Dashboard document. Keep the metadata table
outside the current h3 element and preserve its existing contents and
formatting.
- Line 88: Revise the dashboard sharing note to avoid equating “Anyone with the
link” with teammate-only access. Recommend specific users or groups where
possible, and add an explicit privacy/approval caveat if that public-link
setting is used; clarify that the report owner must update sharing on the
preview or users should share their own copy.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 950c4a81-30c8-4fe0-89ca-e77cebf918d7
📒 Files selected for processing (1)
docs/4. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM Delivery Dashboard.md
| <h3> | ||
| <table> | ||
| <tr> | ||
| <td><b>4 minutes read</b></td> | ||
| <td style={{ paddingLeft: '40px' }}><b>Level: Advanced</b></td> | ||
| <td style={{ paddingLeft: '40px' }}><b>Last Updated: July 2026</b></td> | ||
| </tr> | ||
| </table> | ||
| </h3> |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Start the document with a top-level heading.
The first line is an <h3>, triggering markdownlint MD041 and weakening document navigation/accessibility. Add a # heading before the status table and keep the table outside the heading element.
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/4`. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM
Delivery Dashboard.md around lines 1 - 9, Prepend a top-level Markdown heading
before the existing status table in the HSM Delivery Dashboard document. Keep
the metadata table outside the current h3 element and preserve its existing
contents and formatting.
Source: Linters/SAST tools
| <h3> | ||
| <table> | ||
| <tr> | ||
| <td><b>4 minutes read</b></td> |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the read-time label.
Use “4-minute read” or “4 minutes to read”; “4 minutes read” is grammatically incorrect.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/4`. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM
Delivery Dashboard.md at line 4, Update the read-time label in the documentation
from “4 minutes read” to the grammatically correct “4-minute read” or “4 minutes
to read,” while preserving the existing formatting.
|
|
||
| - Open this link - https://lookerstudio.google.com/u/0/reporting/859eb34f-2f9a-410c-8baa-dacf28af6c33/page/oBhGF/preview in your browser | ||
|
|
||
| - Note: This is a preview link tied to the report owner's account. Before sharing your own copy of this dashboard with your team, click Share in Looker Studio and set access to "Anyone with the link" → Viewer, so teammates outside your account can open it too. |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
Do not present “Anyone with the link” as equivalent to teammate-only access.
This setting allows anyone who obtains the URL to view the dashboard, which can expose the contact names and phone numbers referenced later in the guide. Prefer specific users/groups or add an explicit approval/privacy caveat; also clarify that the report owner must change sharing on the owner-bound preview, or that users should share their own copy.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/4`. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM
Delivery Dashboard.md at line 88, Revise the dashboard sharing note to avoid
equating “Anyone with the link” with teammate-only access. Recommend specific
users or groups where possible, and add an explicit privacy/approval caveat if
that public-link setting is used; clarify that the report owner must update
sharing on the preview or users should share their own copy.
|
@akanshaaa19 The merging is blocked can you please help to merge it please. |
2 participants
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:
Contactstable" step in Part 1 is only used to open the BigQuery query editor in the right dataset context - the query itself only reads from themessagestable. Kept the step as-is per feedback, just added the clarifying note rather than removing 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 buildlocally (with dummy Algolia env vars matching CI) to confirm the docs site still builds cleanly with this change.Test plan
Summary by CodeRabbit