chore(playbook): update docs content source URL from 'documentation' to 'docs'#615
chore(playbook): update docs content source URL from 'documentation' to 'docs'#615Feediver1 wants to merge 2 commits into
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 rp-cloud 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 Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR updates the Antora playbook configuration to reference a different upstream documentation repository. The Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Re-validated 2026-07-20: still valid, still necessary — now the last stragglerSix weeks on, checked whether this one-liner is still worth merging. It is: Not superseded. cloud-docs The premise holds, with fresh evidence. The old URL still resolves (GitHub's rename redirect is alive — verified via New argument since this PR opened: the production playbook ( Scope check: this playbook line is the only functional occurrence of the old URL in cloud-docs. The other grep hits are fine as-is: Residual risk of not merging: GitHub rename redirects die if a new repo ever takes the old name — unlikely, but it would turn this hygiene item into an outage retroactively. One line, zero risk, aligns local with production. Just needs an approval. 🤖 Generated with Claude Code |
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 from the old URL, so Antora's clone still resolves; but the URL string in the playbook becomes the cache key. That means the old URL can persist as a separate cache entry in Netlify build caches, contributing to the multi-axis cache staleness we've been chasing (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
Build logs for those PRs surfaced errors attributed to
https://github.com/redpanda-data/documentation (branch: main)even though the docs repo's own playbook had already been updated to useredpanda-data/docs. The remaining old-URL reference is right here — this PR fixes it.Diff
One line.
No behavioral change to what's fetched (same repo via redirect either way), just the URL string in the cache key.
Companion PR
A matching one-line fix to
rp-connect-docs/local-antora-playbook.ymlwill be opened separately.🤖 Generated with Claude Code