Add FAQ on syncing BigQuery with Google Sheets #569
Conversation
This document outlines the process of syncing data from BigQuery to Google Sheets, highlighting the challenges of direct writing and recommending a more reliable approach. It includes step-by-step instructions for establishing a connection and retrieving data efficiently.
📝 WalkthroughWalkthroughA new documentation file added to the FAQ section that explains the process of syncing BigQuery data with Google Sheets. The guide covers the rationale for fetching data from BigQuery instead of writing directly to Sheets, and provides step-by-step instructions for establishing connections and querying data. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 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-569--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
🤖 Fix all issues with AI agents
In `@docs/8`. FAQ/Sync BigQuery and Google Sheets.md:
- Around line 28-33: The nested list under the "Before proceeding:" heading is
indented by 5 spaces which violates markdownlint; change the indentation of the
two nested bullets ("This method ensures..." and "Access to BigQuery...") to 2
spaces (one indentation level) so they are proper child bullets of "Before
proceeding:". Ensure the bullets remain prefixed with "-" and keep their text
unchanged.
🧹 Nitpick comments (2)
docs/8. FAQ/Sync BigQuery and Google Sheets.md (2)
16-34: Use proper headings instead of bolded lines.These bold lines are functioning as section headings and trigger MD036. Convert them to real headings for structure and accessibility.
✅ Suggested heading fixes
-**Challenges of Writing Directly to Google Sheets** +### Challenges of Writing Directly to Google Sheets -**Recommended Approach** +### Recommended Approach -**Next Steps** +### Next Steps
61-67: Optional: reduce repeated “want to” phrasing.The phrasing repeats in adjacent steps; consider small wording variety.
✍️ Optional wording tweak
-- On the next screen, select the dataset from which you want to retrieve data. +- On the next screen, select the dataset you will retrieve data from. -- Choose the table you want to connect and click Connect. +- Choose the table to connect and click Connect.
| - Before proceeding: | ||
|
|
||
| - This method ensures reliable data retrieval and reduces failures, unless the BigQuery instance experiences issues. | ||
|
|
||
| - Access to BigQuery is required for setting up this approach, but end users of the Google Sheet do not need BigQuery access. | ||
|
|
There was a problem hiding this comment.
Fix nested list indentation to satisfy markdownlint.
The nested bullets are indented by 5 spaces; the linter expects 2.
🛠️ Indentation fix
- - This method ensures reliable data retrieval and reduces failures, unless the BigQuery instance experiences issues.
-
- - Access to BigQuery is required for setting up this approach, but end users of the Google Sheet do not need BigQuery access.
+ - This method ensures reliable data retrieval and reduces failures, unless the BigQuery instance experiences issues.
+
+ - Access to BigQuery is required for setting up this approach, but end users of the Google Sheet do not need BigQuery access.📝 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.
| - Before proceeding: | |
| - This method ensures reliable data retrieval and reduces failures, unless the BigQuery instance experiences issues. | |
| - Access to BigQuery is required for setting up this approach, but end users of the Google Sheet do not need BigQuery access. | |
| - Before proceeding: | |
| - This method ensures reliable data retrieval and reduces failures, unless the BigQuery instance experiences issues. | |
| - Access to BigQuery is required for setting up this approach, but end users of the Google Sheet do not need BigQuery access. | |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 30-30: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
[warning] 32-32: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
🤖 Prompt for AI Agents
In `@docs/8`. FAQ/Sync BigQuery and Google Sheets.md around lines 28 - 33, The
nested list under the "Before proceeding:" heading is indented by 5 spaces which
violates markdownlint; change the indentation of the two nested bullets ("This
method ensures..." and "Access to BigQuery...") to 2 spaces (one indentation
level) so they are proper child bullets of "Before proceeding:". Ensure the
bullets remain prefixed with "-" and keep their text unchanged.
This document outlines the process of syncing data from BigQuery to Google Sheets, highlighting the challenges of direct writing and recommending a more reliable approach. It includes step-by-step instructions for establishing a connection and retrieving data efficiently.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.