Update onboarding document with GCS setup details #571
Conversation
Updated last updated date and added Google Cloud Storage setup instructions.
📝 WalkthroughWalkthroughThis PR updates the WhatsApp Groups Automation onboarding documentation for new NGOs by adding a new Step 4 focused on Google Cloud Storage setup and refreshing the last updated timestamp to February 2026. 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-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.
| </h3> | ||
|
|
||
| ### Contents | ||
| 1. [Pre-requisites](#pre-requisites) |
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
|
|
||
| ### 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) |
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
|
|
||
| 1. In Maytapi go to webhook and enter the following webhook url `https://api.**ngo-shortcode**.glific.com/maytapi` | ||
|
|
||
| Ex, if your glific domain is `www.xyz.glific.com` then use the maytapi webhook url becomes `https://api.xyz.glific.com/maytapi` |
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
|
|
||
| <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
Updated last updated date and added Google Cloud Storage setup instructions.
Summary by CodeRabbit