chore(playbook): update docs content source URL from 'documentation' to 'docs'#440
Conversation
The repo `redpanda-data/documentation` was renamed to `redpanda-data/docs` some time ago. GitHub follows the redirect transparently when Antora fetches, but the old URL becomes the cache key, so it can stick around in build caches and contribute to stale-content issues. Use the current canonical name to make the playbook clearer and to invalidate any cached entries keyed on the old name on the next build. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates the Antora playbook configuration to reference a different upstream Git repository for documentation content. The Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Summary
Updates the docs content source URL in
local-antora-playbook.ymlfrom the oldredpanda-data/documentationto the currentredpanda-data/docs.Why
The repo was renamed from
redpanda-data/documentationtoredpanda-data/docspreviously. GitHub serves an HTTP 301 redirect, so Antora's clone still resolves; but the URL string in the playbook becomes the cache key. The old URL persists as a separate cache entry in Netlify build caches, contributing to multi-axis cache staleness (broken xref attributions pointing atredpanda-data/documentation (branch: main)in build logs).Using the current canonical name:
Verified during diagnosis of redpanda-data/docs#1734 / #1741
Those build logs surfaced errors attributed to
https://github.com/redpanda-data/documentation (branch: main)even though the docs repo's own playbook had already been updated. The remaining old-URL references are here inrp-connect-docsand incloud-docs— this PR fixes the rp-connect-docs side.Diff
One line.
No behavioral change to what's fetched (same repo via redirect either way), just the URL string in the cache key.
Out of scope
This PR does not touch:
.github/ISSUE_TEMPLATE/01_doc_request.yml— still contains aredpanda-data/documentation/issuesURL. Cosmetic; the redirect still works for users clicking the link..github/pull-request-template.md— contains aredpanda-data/documentation-private/issues/URL. Different repo with its own rename history; separate decision.Companion PR
A matching one-line fix to
cloud-docs/local-antora-playbook.ymlis at redpanda-data/cloud-docs#615.🤖 Generated with Claude Code