DOC-2303: Add local-build GitHub auth instructions for private content repos - #1879
DOC-2303: Add local-build GitHub auth instructions for private content repos#1879JakeSCahill wants to merge 3 commits into
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughREADME.adoc adds prerequisites for Antora builds that fetch private GitHub repositories. The documentation covers GitHub CLI authentication, fine-grained personal access token permissions, Estimated code review effort: 1 (Trivial) | ~3 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.adoc`:
- Around line 65-76: Update the README’s private repository list and
fine-grained PAT instructions to match the repositories configured in
local-antora-playbook.yml and fetched by npm run build: docs, cloud-docs,
redpanda-labs, rp-connect-docs, and docs-site. Remove adp-docs references and
ensure the access guidance names the complete, accurate repository set.
- Line 67: Update the Antora credentials guidance in the README to document both
the default ~/.git-credentials location and the XDG fallback path. Also mention
how to configure an explicit credential path for credentials stored outside
these default locations.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Fix repo lists to match each playbook, soften credential-source wording, add XDG fallback path, remove em dash, use verb-phrase heading, add new-tab carets to external links. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 participant
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-2303
Review deadline: 2026-08-11
The doc content repos (
docs,cloud-docs,rp-connect-docs,adp-docs) are being made private. Antora fetches these repos as remote content sources during every local build, and it does not use git credential helpers, so writers need a one-time credentials setup that isn't covered by an existingghor keychain login.This PR adds a Set up GitHub authentication section to the README documenting the one-time
~/.git-credentialssetup Antora requires. The private-repo list in the section matches this repo'slocal-antora-playbook.ymlcontent sources.Merge alongside the repo visibility change (tracked in DEVPROD-4604).
Page previews
None: README changes only, no site pages affected.
Checks
🤖 Generated with Claude Code