Update onboarding document with GCS setup details#571
Update onboarding document with GCS setup details#571SangeetaMishr wants to merge 4 commits intomainfrom
Conversation
Updated last updated date and added Google Cloud Storage setup instructions.
📝 WalkthroughWalkthroughThis PR updates the WhatsApp Groups Automation onboarding doc: refreshes "Last Updated" to February 2026, reorders and renumbers the Contents/steps, expands prerequisites (group naming examples and phone-number membership), and adds a new "Step 4: Google Cloud Storage Setup" with link and messaging/webhook wording refinements. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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-571--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md (1)
11-14:⚠️ Potential issue | 🟡 MinorUpdate the Contents list to include Step 4.
The new Step 4 isn’t reflected in the contents, which makes navigation incomplete.🧭 Suggested update
### Contents 1. [Pre-requisites](`#pre-requisites`) 2. [Set-up](`#set-up`) +3. [Step 4: Google Cloud Storage Setup](`#step-4-google-cloud-storage-setup`) 8. [Pricing](`#pricing`)
🤖 Fix all issues with AI agents
In `@docs/6`. WhatsApp Groups Automation/Onboarding for new NGOs.md:
- Line 58: The link text "here:" in the sentence linking to the GCS
documentation is non-descriptive (violates MD059); update the anchor text to a
descriptive phrase such as "Google Cloud Storage setup guide" or "Google Cloud
Storage (GCS) setup instructions" while keeping the same URL
(https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS/)
so the line reads something like: Please refer to the Google Cloud Storage setup
guide for detailed instructions on how to configure and set up GCS.
🧹 Nitpick comments (1)
docs/6. WhatsApp Groups Automation/Onboarding for new NGOs.md (1)
54-56: Keep Step heading levels consistent.
Steps 1–3 use####, but Step 4 is###, which breaks the visual hierarchy. Consider changing Step 4 to####for consistency.💡 Suggested tweak
-### Step 4: Google Cloud Storage Setup +#### Step 4: Google Cloud Storage Setup
|
|
||
| Google Cloud Storage (GCS) is a cloud service offered by Google Cloud Platform (GCP) that enables you to save and access data—like files, images and large datasets—on Google’s secure servers rather than on your own devices. GCS is used for various tasks, such as storing WhatsApp group media and making data available for reporting or analysis through BigQuery. | ||
|
|
||
| Please refer to the detailed instructions on how to configure and set up Google Cloud Storage (GCS) [here:](https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS/) |
There was a problem hiding this comment.
Use descriptive link text for the GCS instructions.
The link text “here:” is non-descriptive and fails MD059. Use explicit text like “Google Cloud Storage setup guide”.
✅ Suggested fix
-Please refer to the detailed instructions on how to configure and set up Google Cloud Storage (GCS) [here:](https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS/)
+Please refer to the detailed instructions on how to configure and set up Google Cloud Storage (GCS) in the [Google Cloud Storage setup guide](https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS/).📝 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.
| Please refer to the detailed instructions on how to configure and set up Google Cloud Storage (GCS) [here:](https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS/) | |
| Please refer to the detailed instructions on how to configure and set up Google Cloud Storage (GCS) in the [Google Cloud Storage setup guide](https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS/). |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 58-58: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In `@docs/6`. WhatsApp Groups Automation/Onboarding for new NGOs.md at line 58,
The link text "here:" in the sentence linking to the GCS documentation is
non-descriptive (violates MD059); update the anchor text to a descriptive phrase
such as "Google Cloud Storage setup guide" or "Google Cloud Storage (GCS) setup
instructions" while keeping the same URL
(https://glific.github.io/docs/docs/Pre%20Onboarding/Google%20Cloud%20Storage%20Setup%20-%20GCS/)
so the line reads something like: Please refer to the Google Cloud Storage setup
guide for detailed instructions on how to configure and set up GCS.
There was a problem hiding this comment.
Since the contents are added in 'link' format, better to change that. it might confuse readers.
for all three - pre-requisites, set-up and pricing @SangeetaMishr
There was a problem hiding this comment.
Does the user need to follow any guidelines while naming a whatsapp group, since it's mentioned that name should be in a appropriate manner? @SangeetaMishr
There was a problem hiding this comment.
Removed the link format
| @@ -46,4 +46,4 @@ | |||
There was a problem hiding this comment.
good to rephrase this sentence to - For example, if your Glific domain is www.xyz.glific.com, then the Maytapi webhook URL becomes https://api.xyz.glific.com/maytapi @SangeetaMishr
There was a problem hiding this comment.
added few examples: Delhi Volunteers
Health Team – Field
Content Review
Workshop 2026 – Logistics
|
|
||
| <img width="1274" alt="Screenshot 2024-11-18 at 3 59 18 PM" src="https://github.com/user-attachments/assets/a2ff1a6e-b034-47e5-90de-ce2bfe37df44" /> | ||
|
|
||
| 2. This completes the set-up |
There was a problem hiding this comment.
better to mention, 5th point of step 2 here or move this image to that section @SangeetaMishr
There was a problem hiding this comment.
Sorry unable to understand this.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/6`. WhatsApp Groups Automation/Onboarding for new NGOs.md:
- Around line 12-14: The Contents list is missing the newly added section;
update the Contents block (the numbered list showing "1. Pre-requisites", "2.
Set-up", "3. Pricing") to include "4. Google Cloud Storage Setup" so the table
of contents matches the document sections and readers can navigate to the new
Step 4.
- Line 54: The "### Step 4: Google Cloud Storage Setup" heading is inconsistent
with Steps 1–3 which use level 4 under the "Set-up" section; update the heading
to match by either changing "### Step 4: Google Cloud Storage Setup" to "####
Step 4: Google Cloud Storage Setup" so it becomes a subsection of "Set-up", or
if you intend it to be a top-level section remove the "Step" wording (e.g.,
"Google Cloud Storage Setup") and relocate it appropriately (before the
"Pricing" heading) to maintain consistent document structure.
| 1. Pre-requisites | ||
| 2. Set-up | ||
| 3. Pricing |
There was a problem hiding this comment.
Add Step 4 to the Contents section.
The newly added "Step 4: Google Cloud Storage Setup" section is not listed in the Contents, creating an incomplete table of contents for readers.
📋 Proposed fix to include Step 4
### Contents
1. Pre-requisites
2. Set-up
-3. Pricing
+3. Google Cloud Storage Setup
+4. Pricing📝 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.
| 1. Pre-requisites | |
| 2. Set-up | |
| 3. Pricing | |
| 1. Pre-requisites | |
| 2. Set-up | |
| 3. Google Cloud Storage Setup | |
| 4. Pricing |
🤖 Prompt for AI Agents
In `@docs/6`. WhatsApp Groups Automation/Onboarding for new NGOs.md around lines
12 - 14, The Contents list is missing the newly added section; update the
Contents block (the numbered list showing "1. Pre-requisites", "2. Set-up", "3.
Pricing") to include "4. Google Cloud Storage Setup" so the table of contents
matches the document sections and readers can navigate to the new Step 4.
|
|
||
| You should be able to see the whatsapp groups option in the left panel that the phone number is part of and perform operations like send, receive and schedule message to a group of groups. | ||
|
|
||
| ### Step 4: Google Cloud Storage Setup |
There was a problem hiding this comment.
Clarify the heading structure.
The heading "### Step 4" uses a level 3 heading, making it a top-level section like "Set-up" itself, whereas Steps 1-3 are level 4 subsections under Set-up. This creates structural inconsistency.
Consider either:
- Making it a subsection under Set-up by changing to
#### Step 4:, or - Removing "Step" terminology since it's a separate top-level section
♻️ Option 1: Make it a subsection of Set-up
Move this section before the "Pricing" heading and change to level 4:
-### Step 4: Google Cloud Storage Setup
+#### Step 4: Google Cloud Storage Setup♻️ Option 2: Remove "Step" terminology for top-level section
-### Step 4: Google Cloud Storage Setup
+### Google Cloud Storage Setup🤖 Prompt for AI Agents
In `@docs/6`. WhatsApp Groups Automation/Onboarding for new NGOs.md at line 54,
The "### Step 4: Google Cloud Storage Setup" heading is inconsistent with Steps
1–3 which use level 4 under the "Set-up" section; update the heading to match by
either changing "### Step 4: Google Cloud Storage Setup" to "#### Step 4: Google
Cloud Storage Setup" so it becomes a subsection of "Set-up", or if you intend it
to be a top-level section remove the "Step" wording (e.g., "Google Cloud Storage
Setup") and relocate it appropriately (before the "Pricing" heading) to maintain
consistent document structure.
Clarified instructions for WhatsApp group naming and provided a clearer example for the Maytapi webhook URL.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/6`. WhatsApp Groups Automation/Onboarding for new NGOs.md:
- Line 18: Change the list item that begins "3. Should have the WhatsApp groups
created and the phone number should be part of the WhatsApp groups..." to use
"2." for correct numbering, and normalize the example formatting by adding a
space after each comma and ensuring consistent spacing around dashes (e.g.,
"Delhi Volunteers, HealthTeam – Field, Workshop 2026 – Logistics"). This updates
the sequence and fixes spacing in the example list.
| ### Pre-requisites | ||
| 1. Have an active phone number with a normal WhatsApp account linked to it. | ||
| 3. Should have the WhatsApp groups created and the phone number should be part of the WhatsApp groups. (it is advised to have the WhatsApp Groups named in an appropriate manner) | ||
| 3. Should have the WhatsApp groups created and the phone number should be part of the WhatsApp groups. (it is advised to have the WhatsApp Groups named in an appropriate manner example: Delhi Volunteers,HealthTeam – Field,Workshop 2026 – Logistics etc. |
There was a problem hiding this comment.
Fix list numbering and improve example formatting.
Two issues in this line:
- Numbering error: The item is numbered "3." but follows only item 1, creating a gap in the sequence. This should be item 2.
- Inconsistent spacing: The examples lack consistent spacing after commas. Consider adding a space after each comma for better readability.
📝 Proposed fix for numbering and formatting
-3. Should have the WhatsApp groups created and the phone number should be part of the WhatsApp groups. (it is advised to have the WhatsApp Groups named in an appropriate manner example: Delhi Volunteers,HealthTeam – Field,Workshop 2026 – Logistics etc.
+2. Should have the WhatsApp groups created and the phone number should be part of the WhatsApp groups. (it is advised to have the WhatsApp Groups named in an appropriate manner example: Delhi Volunteers, HealthTeam – Field, Workshop 2026 – Logistics, etc.)🤖 Prompt for AI Agents
In `@docs/6`. WhatsApp Groups Automation/Onboarding for new NGOs.md at line 18,
Change the list item that begins "3. Should have the WhatsApp groups created and
the phone number should be part of the WhatsApp groups..." to use "2." for
correct numbering, and normalize the example formatting by adding a space after
each comma and ensuring consistent spacing around dashes (e.g., "Delhi
Volunteers, HealthTeam – Field, Workshop 2026 – Logistics"). This updates the
sequence and fixes spacing in the example list.
Revised the pre-requisites section for clarity and formatting. Improved examples of WhatsApp group naming conventions.
2 participants
Updated last updated date and added Google Cloud Storage setup instructions.
Summary by CodeRabbit