Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Document BigQuery connector credentials and configuration #3326

Merged
merged 2 commits into from
Oct 27, 2023

Conversation

esevastyanov
Copy link
Contributor

@esevastyanov esevastyanov commented Oct 26, 2023

Summary by CodeRabbit

  • New Feature: Introduced a mandatory project_id configuration option for Rill projects to facilitate BigQuery connections and job executions. This allows users to specify the project ID for running BigQuery jobs.
  • Documentation: Added comprehensive guides for configuring credentials in Rill for accessing BigQuery. This includes instructions for both local development and deployments on Rill Cloud, as well as a step-by-step guide for creating a service account with BigQuery access using the Google Cloud Console.
  • Documentation: Updated the credentials documentation with a new link to the BigQuery guide for easy reference.

@coderabbitai
Copy link

coderabbitai bot commented Oct 26, 2023

Walkthrough

This change introduces documentation and configuration updates to support BigQuery connections in Rill. It provides instructions for setting up credentials, adds a new project_id configuration option, and updates relevant documentation links.

Changes

File Path Summary
docs/docs/deploy/credentials/bigquery.md Added documentation for configuring BigQuery credentials in Rill.
docs/docs/deploy/credentials/credentials.md Updated with a new link to the BigQuery documentation.
docs/docs/reference/project-files/sources.md Introduced a new project_id configuration option for BigQuery connections.

🐇

In the land of code, where the shadows lie,

BigQuery connections, now reach the sky.

With credentials set, and project ID,

Rill's power grows, as you can see! 🎉


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.json

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4d675ea and 5df2bd3.
Files selected for processing (2)
  • docs/docs/deploy/credentials/bigquery.md (1} hunks)
  • docs/docs/deploy/credentials/credentials.md (1} hunks)
Files skipped from review due to trivial changes (2)
  • docs/docs/deploy/credentials/bigquery.md
  • docs/docs/deploy/credentials/credentials.md

@esevastyanov esevastyanov requested a review from k-anshul October 26, 2023 13:43
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5df2bd3 and 8d9507a.
Files selected for processing (1)
  • docs/docs/reference/project-files/sources.md (1} hunks)
Files skipped from review due to trivial changes (1)
  • docs/docs/reference/project-files/sources.md

Copy link
Contributor

@begelundmuller begelundmuller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

@begelundmuller begelundmuller merged commit b0e1cce into main Oct 27, 2023
2 checks passed
@begelundmuller begelundmuller deleted the 3196-bq-docs branch October 27, 2023 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants