Repository navigation
docs: explain why GCS is needed and each settings field - #688
Open
SangeetaMishr wants to merge 2 commits into
Open
SangeetaMishr wants to merge 2 commits into
SangeetaMishr wants to merge 2 commits into
Conversation
Adds a "Why does Glific need GCS?" section covering the concrete features that depend on it (media uploads, AI voice replies, BigQuery reporting, chat media backup), grounded in the actual provider field schema from glific/glific (priv/repo/seeds/..._alter_glific_data.exs). Also fixes the Integrate GCS/BigQuery/Google Sheets sections, which previously instructed pasting both the JSON key and a "client email" into the same single Goth Credentials field — there is only one such field per integration, and it takes the full JSON. Replaces this with a field table per integration (what to enter, why it's needed) and a note on sharing Sheets with the service account's client_email. Closes #682
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
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-688--glific-docs.netlify.app |
Grounded in the actual screenshots already in the doc: - Bucket creation: explains bucket name uniqueness, location/location type tradeoffs, why Standard storage class fits chat media (vs Nearline/Coldline/Archive), and Uniform vs Fine-grained access control. Flags that Public access prevention must be Off, since the doc's own later "Making bucket Public" step (granting allUsers) fails otherwise — visible as "Public access prevention: On" in the existing create-bucket screenshot. - Service account: explains why a service account (non-human identity) is needed instead of a personal login, why Owner role is granted (same account/key is reused across GCS, BigQuery, and Sheets), and why a JSON key specifically (Glific runs outside GCP and needs a portable credential) plus how to react if the key leaks.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
glific/glific(priv/repo/seeds/..._alter_glific_data.exs), each integration (Google Cloud Storage, BigQuery, Google Sheets) has exactly one such field, which takes the full JSON key content.client_emailfor Glific to have access.allUsersaccess) will fail if it's left enabled. This was a real gap: the doc walks through making the bucket public without ever mentioning this blocker.Screenshots and the step-by-step account/project creation flow are unchanged — only explanatory text was added alongside existing images.
Test plan
yarn start) and confirm the new tables and explanatory text render correctly under Step 4 and Step 5allUsersgrant in "Making bucket Public" (sanity-check before merge, since this is a new claim added to the doc)Closes #682