Skip to content

docs: Update GCS documentation for explicit credentials flow (PR #8142) - #8166

Merged
royendo merged 68 commits into
mainfrom
claude-ai-docs-creator-script
Nov 6, 2025
Merged

royendo merged 68 commits into
mainfrom
claude-ai-docs-creator-script

Conversation

@royendo

@royendo royendo commented Oct 24, 2025

Copy link
Copy Markdown
Contributor

Summary

Updates the GCS connector documentation to reflect the new explicit credentials flow introduced in PR #8142.

Changes

  • Two-step authentication flow: Documented the new Step 1 (Configure Authentication) → Step 2 (Configure Data Source) process
  • Service Account JSON: Added UI instructions for uploading JSON key files directly in the interface
  • HMAC Keys: Enhanced documentation with Google Cloud Console instructions and proper configuration examples
  • Connector/Source separation: Updated all YAML examples to show proper separation between connector files and source files
  • Deployment clarifications: Updated Rill Cloud deployment section to mention both authentication methods

Documentation Updates

New Sections

  • "Using the Add Data UI" - Overview of the two-step process
  • "Using the UI" subsections for both Service Account JSON and HMAC keys
  • "Manual Configuration" subsections showing connector/source file structure

Updated Content

  • All YAML examples now show proper connector/source separation
  • Enhanced HMAC key generation instructions (Console + CLI)
  • Clarified S3-compatible authentication mode for HMAC keys
  • Updated deployment requirements

Related

Test Plan

  • Reviewed documentation for accuracy against code changes
  • Verified all YAML examples are syntactically correct
  • Checked links and references
  • Ensured consistent formatting and style

🤖 Generated with Claude Code

- Document new two-step authentication flow (Step 1: Auth → Step 2: Source)
- Add UI instructions for uploading service account JSON files
- Add detailed HMAC key generation and configuration steps
- Update YAML examples to show proper connector/source separation
- Clarify deployment requirements for Rill Cloud

Related to PR #8142

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@royendo
royendo requested a review from ericpgreen2 October 24, 2025 16:44
@royendo

royendo commented Oct 24, 2025 •

Copy link
Copy Markdown
Contributor Author

from our call discussion, it does a decent job but will still require some hand holding as it uses some old syntax for source ingestion IE

type: source

connector: gcs

path: "gs://your-bucket/path/to/data.parquet"

But in terms of text and generic docs, its not a bad first pass.
Separates UI creation vs manual creation.

Comment thread .github/workflows/claude-review-apply.yml Outdated
@ericpgreen2
ericpgreen2 requested a review from ericokuma October 28, 2025 02:08
@royendo

royendo commented Oct 28, 2025

Copy link
Copy Markdown
Contributor Author

doclaude: fix source references to models

@royendo

royendo commented Oct 28, 2025

Copy link
Copy Markdown
Contributor Author

/DoClaude source is deprecated, use model instead

type: source

connector: gcs

path: "gs://your-bucket/path/to/data.parquet"

@grahamplata
grahamplata marked this pull request as ready for review October 28, 2025 19:49
@royendo

royendo commented Oct 28, 2025

Copy link
Copy Markdown
Contributor Author

/claude apply changes: source is deprecated, use model instead

@grahamplata
grahamplata self-requested a review October 28, 2025 19:51
Comment thread docs/docs/build/connectors/data-source/gcs.md
@github-actions

Copy link
Copy Markdown
Contributor

✅ Claude processed feedback and attempted fixes.

  • Branch: claude-ai-docs-creator-script
  • Outcome: failure

If something looks off, you can push follow-ups or comment /claude apply again.

@royendo

royendo commented Oct 28, 2025

Copy link
Copy Markdown
Contributor Author

DoClaude review the inline comments and make changes

@royendo royendo left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

also, re add the supported files.

Comment thread docs/docs/connect/data-source/gcs.md Outdated
Comment thread docs/docs/connect/data-source/gcs.md Outdated
Comment thread docs/docs/connect/data-source/gcs.md Outdated
Comment thread docs/docs/connect/data-source/gcs.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

✅ DoClaude processed all inline review comments

📝 Changes have been applied to the branch: claude-ai-docs-creator-script

🔄 Review comments have been marked as addressed

📚 The agent analyzed the review comments and may have updated .github/scripts/instructions.md with new learnings to improve future responses.

Review the commit and push additional changes if needed.

@royendo royendo left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

last few changes

Comment thread docs/docs/connect/data-source/gcs.md
Comment thread docs/docs/connect/data-source/gcs.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

✅ DoClaude processed all inline review comments

📝 Changes have been applied to the branch: claude-ai-docs-creator-script

🔄 Review comments have been marked as addressed

📚 The agent analyzed the review comments and may have updated .github/scripts/instructions.md with new learnings to improve future responses.

Review the commit and push additional changes if needed.

@github-actions

Copy link
Copy Markdown
Contributor

✅ DoClaude processed all inline review comments

📝 Changes have been applied to the branch: claude-ai-docs-creator-script

🔄 Review comments have been marked as addressed

📚 The agent analyzed the review comments and may have updated .github/scripts/instructions.md with new learnings to improve future responses.

Review the commit and push additional changes if needed.

@royendo royendo left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

last final 2?

Comment thread docs/docs/connect/data-source/gcs.md Outdated
Comment thread docs/docs/connect/data-source/gcs.md Outdated
Comment thread docs/docs/connect/data-source/gcs.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

✅ DoClaude processed all inline review comments

📝 Changes have been applied to the branch: claude-ai-docs-creator-script

🔄 Review comments have been marked as addressed

📚 The agent analyzed the review comments and may have updated .github/scripts/instructions.md with new learnings to improve future responses.

Review the commit and push additional changes if needed.

@royendo

royendo commented Oct 30, 2025

Copy link
Copy Markdown
Contributor Author

@ericpgreen2 , @ericokuma

This gcs.md doc here is 100% modified by Claude taking into account in-line code review comments, making changes, then resolving the comments. It also appends to its own instructions.md to get "smarter over time"

<!-- Added from PR review - 2025-01-xx: Deployment documentation standards -->
### Deployment Instructions

**When documenting deployment and environment configuration:**

- ✅ **Keep it simple**: Use `rill env configure` without additional arguments
  - The CLI will walk through all required connectors interactively
  - WRONG: `rill env configure connector.gcs.google_application_credentials`
  - RIGHT: `rill env configure`

- ❌ **Don't use these commands in deploy docs**:
  - `rill env set` - Not part of standard deployment workflow
  - `rill env push` - Not part of standard deployment workflow
  - `rill env pull` - Not part of standard deployment workflow

The PR is an interesting one, (i need to work on the trigger to start the workload on PR comments (not in-line), its currently set to push).

The ideal workflow is: For PRs that require doc changes, we can trigger a doc creation, either locally with Claude or however to create an open/draft PR. The AI will read the code changes and modify (never create new files) the existing docs and open the PR. For any mistakes and fine tuning, we can in-line comment review, tag the engineer if the AI's understanding is correct then trigger the rewrite.

I assume itll take a few iterations but this way the doc review process can be completed with myself, and the user who worked on the code themselves.

Open to thoughts and ideas!
If you got any interesting PRs to create more examples, LMK.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ DoClaude encountered an issue

Branch: claude-ai-docs-creator-script
Outcome: cancelled

Check the workflow logs for details.

@royendo
royendo requested a review from ericpgreen2 October 31, 2025 13:32

@ericpgreen2 ericpgreen2 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The writing and structure generally looks good to me! Though perhaps @ericokuma also wants to review this as a Product stakeholder.

@ericpgreen2

ericpgreen2 commented Oct 31, 2025 •

Copy link
Copy Markdown
Contributor

The AI will read the code changes and modify (never create new files) the existing docs and open the PR

I wonder if "never create new files" is too restrictive? Like, I see the model tests feature rightfully merited a new docs page.

@royendo

royendo commented Oct 31, 2025

Copy link
Copy Markdown
Contributor Author

The AI will read the code changes and modify (never create new files) the existing docs and open the PR

works for the agent because the local DOC AI can make new changes but a in-line code review should just make changes,

@ericokuma

Copy link
Copy Markdown
Contributor

Feedback:

  • this is quite important that it might benefit from an actual info box so it doesn't get glanced over
Screenshot 2025-11-03 at 9 33 42 AM
  • since Service Account JSON is recommended, it might be good to put that in the title of the section i.e. Service Account JSON (recommended method)

  • The "Deploy to Rill Cloud" section is a bit confusing especially this line: "When deploying your project to Rill Cloud, you must provide a JSON key file for a Google Cloud service account with appropriate read access/permissions to the buckets used in your project". Is this key file separate from the service account JSON?

@bito-code-review

Copy link
Copy Markdown

Based on the PR changes, here are responses to your feedback: 1) An info box would indeed help highlight the importance of authentication method selection - this could be added before the authentication methods section. 2) The section title could be updated to 'Method 1: Service Account JSON (Recommended)' to emphasize it's the preferred approach. 3) The 'Deploy to Rill Cloud' section refers to the same Service Account JSON file mentioned earlier - it's not a separate key file, but rather emphasizing that the JSON credentials configured in your connector must be present for cloud deployment to work.

docs/docs/build/connectors/data-source/gcs.md

## Method 1: Service Account JSON (Recommended)

Service Account JSON credentials provide the most secure and reliable authentication for GCS. This method works for both local development and Rill Cloud deployments.

@ericokuma

Copy link
Copy Markdown
Contributor

Based on the PR changes, here are responses to your feedback: 1) An info box would indeed help highlight the importance of authentication method selection - this could be added before the authentication methods section. 2) The section title could be updated to 'Method 1: Service Account JSON (Recommended)' to emphasize it's the preferred approach. 3) The 'Deploy to Rill Cloud' section refers to the same Service Account JSON file mentioned earlier - it's not a separate key file, but rather emphasizing that the JSON credentials configured in your connector must be present for cloud deployment to work.

docs/docs/build/connectors/data-source/gcs.md

## Method 1: Service Account JSON (Recommended)

Service Account JSON credentials provide the most secure and reliable authentication for GCS. This method works for both local development and Rill Cloud deployments.

Whoa? what the heck is this bot??

@royendo
royendo merged commit f04e8e1 into main Nov 6, 2025
4 checks passed
@royendo
royendo deleted the claude-ai-docs-creator-script branch November 6, 2025 17:23
grahamplata added a commit that referenced this pull request Nov 11, 2025
… (#8166)

* docs: Update GCS documentation for PR #8142 explicit credentials flow

- Document new two-step authentication flow (Step 1: Auth → Step 2: Source)
- Add UI instructions for uploading service account JSON files
- Add detailed HMAC key generation and configuration steps
- Update YAML examples to show proper connector/source separation
- Clarify deployment requirements for Rill Cloud

Related to PR #8142

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* testing reviews

* Update claude-review-apply.yml

* Update claude-review-apply.yml

* test

* change command to doclaude

* doclaude

* Update claude-apply-comments.yml

* test

* fix

* revert

* test

* add on

* use examples triggers

* adjust

* adding script bavck

* Update claude-review-apply.yml

* Update claude-review-apply.yml

* Update claude-review-apply.yml

* Update claude-review-apply.yml

* Update claude-review-apply.yml

* Update claude-review-apply.yml

* test

* test

* get all text

* all text 2

* model tesat

* claude 45

* Update claude-review-apply.yml

* 45

* docs: Apply DoClaude inline review comments

* full md file

* docs: Apply DoClaude inline review comments

* Revert "45"

This reverts commit eb4b9fa.

* retry

* docs: Apply DoClaude inline review comments

* Update gcs.md

* revert

* trigger wokrflow

* docs: Apply DoClaude inline review comments

* Revert "docs: Apply DoClaude inline review comments"

This reverts commit 70405d0.

* attempt 2

* docs: Apply DoClaude inline review comments

* live improvements

* docs: Apply DoClaude review comments and update instructions

* rmeove review comments

* docs: Apply DoClaude review comments and update instructions

* try remove comments again

* docs: Apply DoClaude review comments and update instructions

* debug

* docs: Apply DoClaude review comments and update instructions

* oops, was pending reviews

* docs: Apply DoClaude review comments and update instructions

* trigger

* docs: Apply DoClaude review comments and update instructions

* last

* docs: Apply DoClaude review comments and update instructions

* final last

* docs: Apply DoClaude review comments and update instructions

* Update claude_apply.py

* docs: Apply DoClaude review comments and update instructions

* removed ai files.

* as requested

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Graham Plata <graham.plata@gmail.com>
Co-authored-by: claude-bot <actions@github.com>
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.

5 participants