Revise last updated date and add access instructions#587
Revise last updated date and add access instructions#587SangeetaMishr wants to merge 1 commit intomainfrom
Conversation
Updated last updated date and added section on Google Sheet access via Service Account.
📝 WalkthroughWalkthroughUpdated documentation for Google Sheets linking in Glific by adding metadata refresh and introducing a new section describing Service Account-based permission setup as an alternative to broad "Anyone can" access controls. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
|
🚀 Deployed on https://deploy-preview-587--glific-docs.netlify.app |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/4`. Product Features/03. Flows/2. Flow Actions/12. Link Google
Sheets.md:
- Around line 385-397: Make the Google Sheets access guidance consistently
recommend using the Google Service Account flow (the "Google Sheet Access via
Service Account" section) as the primary and preferred method, and change any
earlier instructions that instruct users to set "Anyone with the link"/"Anyone
can read" sharing to instead mark that link-sharing as discouraged/deprecated
and only for non-PII test data; update the earlier section that mentions "Anyone
with the link" to explicitly warn about data exposure, point readers to the
service-account sharing steps (referencing the "Google Sheet Access via Service
Account" heading), and remove or rephrase any step that instructs granting link
access as a normal configuration.
- Around line 387-397: Rewrite the paragraph into clear numbered steps and fix
typos: replace "To ensure sensitive beneficiary data (PII) is protected,avoid
linking Google Sheets..." with a full sentence and space after the comma; change
"will be access" to "will be accessed"; remove the stray "Link Sheet in Glific"
line and fold that action into the step list; produce 3–4 numbered steps that
instruct the user to open the Google Sheet, click Share and paste the service
account email (from the JSON key) with Viewer or Editor permission, and note
that the sheet will be accessed via the Glific service account respecting those
permissions.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: fb364868-539e-4553-b56d-585a4dddbf50
📒 Files selected for processing (1)
docs/4. Product Features/03. Flows/2. Flow Actions/12. Link Google Sheets.md
| ### Google Sheet Access via Service Account | ||
|
|
||
| To ensure sensitive beneficiary data (PII) is protected,avoid linking Google Sheets in Anyone can read or Anyone can read/write modes. | ||
|
|
||
| Instead, configure access via the Google Service Account linked to your Glific instance. | ||
|
|
||
|
|
||
| Open the Google Sheet you want to link. | ||
|
|
||
| Click Share → Paste the service account email (from the JSON key) and set the permission to either Viewer (read-only) or Editor (read/write). | ||
| Link Sheet in Glific | ||
| Now the sheet will be access via the service account, respecting the permissions set. | ||
|
|
There was a problem hiding this comment.
Resolve conflicting access guidance to avoid insecure configuration.
This new section recommends service-account sharing, but earlier instructions still tell users to set Anyone with the link access (Line 45). That contradiction can still lead to broad, unintended data exposure for beneficiary data.
Please make service-account sharing the primary path and explicitly mark link-sharing as discouraged/deprecated where it still appears.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/4`. Product Features/03. Flows/2. Flow Actions/12. Link Google Sheets.md
around lines 385 - 397, Make the Google Sheets access guidance consistently
recommend using the Google Service Account flow (the "Google Sheet Access via
Service Account" section) as the primary and preferred method, and change any
earlier instructions that instruct users to set "Anyone with the link"/"Anyone
can read" sharing to instead mark that link-sharing as discouraged/deprecated
and only for non-PII test data; update the earlier section that mentions "Anyone
with the link" to explicitly warn about data exposure, point readers to the
service-account sharing steps (referencing the "Google Sheet Access via Service
Account" heading), and remove or rephrase any step that instructs granting link
access as a normal configuration.
| To ensure sensitive beneficiary data (PII) is protected,avoid linking Google Sheets in Anyone can read or Anyone can read/write modes. | ||
|
|
||
| Instead, configure access via the Google Service Account linked to your Glific instance. | ||
|
|
||
|
|
||
| Open the Google Sheet you want to link. | ||
|
|
||
| Click Share → Paste the service account email (from the JSON key) and set the permission to either Viewer (read-only) or Editor (read/write). | ||
| Link Sheet in Glific | ||
| Now the sheet will be access via the service account, respecting the permissions set. | ||
|
|
There was a problem hiding this comment.
Tighten wording and convert to clear step-by-step instructions.
There are a few readability issues (protected,avoid, will be access, and standalone “Link Sheet in Glific”). This section should be normalized into numbered steps for consistency with the rest of the doc.
✍️ Suggested rewrite
- To ensure sensitive beneficiary data (PII) is protected,avoid linking Google Sheets in Anyone can read or Anyone can read/write modes.
+ To protect sensitive beneficiary data (PII), avoid linking Google Sheets using **Anyone with the link** access (read or read/write).
- Instead, configure access via the Google Service Account linked to your Glific instance.
+ Instead, configure access through the Google Service Account linked to your Glific instance.
- Open the Google Sheet you want to link.
-
- Click Share → Paste the service account email (from the JSON key) and set the permission to either Viewer (read-only) or Editor (read/write).
- Link Sheet in Glific
- Now the sheet will be access via the service account, respecting the permissions set.
+ 1. Open the Google Sheet you want to link.
+ 2. Click **Share**, paste the service account email (from the JSON key), and grant:
+ - **Viewer** for read-only access, or
+ - **Editor** for read/write access.
+ 3. Link the sheet in Glific using the same Sheet URL.
+ 4. Access will now be enforced via the service account permissions.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| To ensure sensitive beneficiary data (PII) is protected,avoid linking Google Sheets in Anyone can read or Anyone can read/write modes. | |
| Instead, configure access via the Google Service Account linked to your Glific instance. | |
| Open the Google Sheet you want to link. | |
| Click Share → Paste the service account email (from the JSON key) and set the permission to either Viewer (read-only) or Editor (read/write). | |
| Link Sheet in Glific | |
| Now the sheet will be access via the service account, respecting the permissions set. | |
| To protect sensitive beneficiary data (PII), avoid linking Google Sheets using **Anyone with the link** access (read or read/write). | |
| Instead, configure access through the Google Service Account linked to your Glific instance. | |
| 1. Open the Google Sheet you want to link. | |
| 2. Click **Share**, paste the service account email (from the JSON key), and grant: | |
| - **Viewer** for read-only access, or | |
| - **Editor** for read/write access. | |
| 3. Link the sheet in Glific using the same Sheet URL. | |
| 4. Access will now be enforced via the service account permissions. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/4`. Product Features/03. Flows/2. Flow Actions/12. Link Google Sheets.md
around lines 387 - 397, Rewrite the paragraph into clear numbered steps and fix
typos: replace "To ensure sensitive beneficiary data (PII) is protected,avoid
linking Google Sheets..." with a full sentence and space after the comma; change
"will be access" to "will be accessed"; remove the stray "Link Sheet in Glific"
line and fold that action into the step list; produce 3–4 numbered steps that
instruct the user to open the Google Sheet, click Share and paste the service
account email (from the JSON key) with Viewer or Editor permission, and note
that the sheet will be accessed via the Glific service account respecting those
permissions.
Updated last updated date and added section on Google Sheet access via Service Account.
Summary by CodeRabbit
Release Notes