Create GCS_Bucket.md #343
Create GCS_Bucket.md #343
Conversation
added a new file on gcs bucket to keep private
WalkthroughA new FAQ document was added to the documentation, explaining the rationale for setting Google Cloud Storage (GCS) buckets to public. The document outlines use cases, cautions about sensitive data, and clarifies the distinction between GCS buckets and BigQuery tables for different data types. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
🚀 Deployed on https://deploy-preview-343--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: 0
🧹 Nitpick comments (6)
docs/6. FAQ/GCS_Bucket.md (6)
1-3: Trim non-standard heading markup; it’s likely to mis-renderThe giant “> ### 3 minute read …
Beginner” block mixes a block-quote, multiple bold markers, back-ticks, and dozens of hard-coded spaces.
Markdown renderers will collapse the whitespace and the result will look broken / unpredictable.-> ### **3 minute read** `Beginner` +> **Beginner – 3 minute read**Consider keeping the badge simple (one bold line) or using the project’s existing front-matter pattern if available.
6-6: Polish grammar & style in the first paragraph
- “
GCS (Google Cloud Storage)bucket” → “Google Cloud Storage (GCS) bucket”- Add the missing period after “etc.”
- Drop back-ticks; this is plain prose, not code.
-The `GCS (Google Cloud Storage)` bucket is set to public to make it easier to share files—like PDFs, images, videos etc —without needing user authentication. +A Google Cloud Storage (GCS) bucket is set to public to make it easier to share files—like PDFs, images, and videos, etc.—without requiring user authentication.
12-12: Remove the double determiner “a the”-If an NGO’s bot sends a PDF through a the chatbot, and the file is stored in a public bucket, ... +If an NGO’s bot sends a PDF through the chatbot, and the file is stored in a public bucket, ...
15-15: Friendlier heading phrasingThe “Is it possible to …” construction is flagged as needlessly formal.
A concise alternative:-## Is it possible to keep my GCS bucket private instead of making it public? +## Can I keep my GCS bucket private?
17-19: Remove back-ticks around plain termsInline code formatting is best reserved for commands or code. Here it adds visual noise.
-It's perfectly fine to keep your `GCS bucket` private as long as you don't plan to share any content publicly. +It's perfectly fine to keep your GCS bucket private as long as you don't plan to share any content publicly.Repeat the same change for “
BigQuery tables” and “GCS buckets” below.
21-24: Minor list tightening & parallelism-Also, just to clarify — BigQuery tables and GCS buckets serve different purposes. - -- BigQuery tables are used to store structured data (like databases). -- GCS buckets are used to store media files such as images, audio, and documents. +Also, BigQuery tables and GCS buckets serve different purposes: + +- **BigQuery tables** – store structured data (similar to database tables). +- **GCS buckets** – store unstructured media such as images, audio, and documents.Improves readability and keeps bullet nouns parallel.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/6. FAQ/GCS_Bucket.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/6. FAQ/GCS_Bucket.md
[grammar] ~6-~6: Did you mean “too public to”?
Context: ...S (Google Cloud Storage)` bucket is set to public to make it easier to share files—like PDFs...
(TOO_ADJECTIVE_TO)
[style] ~6-~6: In American English, abbreviations like “etc.” require a period.
Context: ...o share files—like PDFs, images, videos etc —without needing user authentication. ...
(ETC_PERIOD)
[grammar] ~12-~12: Two determiners in a row. Choose either “a” or “the”.
Context: ...e: If an NGO’s bot sends a PDF through a the chatbot, and the file is stored in a pu...
(DT_DT)
[style] ~15-~15: Consider using a more polite way of asking this question.
Context: ...curely with proper access controls. ## Is it possible to keep my GCS bucket private instead o...
(IS_IT_POSSIBLE_TO)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/6. FAQ/GCS_Bucket.md (4)
1-1: Header style deviates from existing docs patternThe long, block-quoted header with repeated non-breaking spaces is visually noisy and doesn’t match the simpler H1/H2 pattern used in the rest of the FAQ section. Consider replacing it with a plain title (e.g.,
# Public vs Private GCS Buckets) or use the same front-matter component the other FAQ pages rely on.
6-6: Grammar & punctuation tweaks for clarityMinor edits improve readability and American-English punctuation:
- The `GCS (Google Cloud Storage)` bucket is set to public to make it easier to share files—like PDFs, images, videos etc — without needing user authentication. + The `Google Cloud Storage (GCS)` bucket is set to public to make it easier to share files—like PDFs, images, videos, etc.—without needing user authentication.
13-13: Fix double determiner and extra spacing- If an NGO’s bot sends a PDF through a the chatbot, and the file is stored in a public bucket, the end user can simply tap the link and view it — no login or permission required. + If an NGO’s bot sends a PDF through a chatbot, and the file is stored in a public bucket, the end user can simply tap the link and view it—no login or permission required.
20-20: Highlight signed-URL alternative for private bucketsYou might want to mention that even with a private bucket, media can still be served to chat users via time-limited signed URLs. This gives readers a middle ground between “fully public” and “completely private, no attachments.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/6. FAQ/GCS_Bucket.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/6. FAQ/GCS_Bucket.md
[grammar] ~6-~6: Did you mean “too public to”?
Context: ...S (Google Cloud Storage)` bucket is set to public to make it easier to share files—like PDFs...
(TOO_ADJECTIVE_TO)
[style] ~6-~6: In American English, abbreviations like “etc.” require a period.
Context: ...o share files—like PDFs, images, videos etc — without needing user authentication. ...
(ETC_PERIOD)
[grammar] ~13-~13: Two determiners in a row. Choose either “a” or “the”.
Context: ...e: If an NGO’s bot sends a PDF through a the chatbot, and the file is stored in a pu...
(DT_DT)
[style] ~16-~16: Consider using a more polite way of asking this question.
Context: ...curely with proper access controls. ## Is it possible to keep my GCS bucket private instead o...
(IS_IT_POSSIBLE_TO)
|
@shijithkjayan This is approved but not merged to main ? Shall I go ahead and do it ? |
|
@SangeetaMishr I have merged it, sorry I didnt do it earlier |
added a new file on gcs bucket to keep private
Summary by CodeRabbit