Skip to content

chore(playbook): update docs content source URL from 'documentation' to 'docs'#440

Merged
JakeSCahill merged 1 commit into
mainfrom
fix-stale-docs-repo-url
Jun 16, 2026
Merged

chore(playbook): update docs content source URL from 'documentation' to 'docs'#440
JakeSCahill merged 1 commit into
mainfrom
fix-stale-docs-repo-url

Conversation

@Feediver1

Copy link
Copy Markdown
Contributor

Summary

Updates the docs content source URL in local-antora-playbook.yml from the old redpanda-data/documentation to the current redpanda-data/docs.

Why

The repo was renamed from redpanda-data/documentation to redpanda-data/docs previously. 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 at redpanda-data/documentation (branch: main) in build logs).

Using the current canonical name:

  1. Makes the playbook self-documenting and accurate.
  2. Invalidates any stale cache entry keyed on the old name on the next preview build.

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 in rp-connect-docs and in cloud-docs — this PR fixes the rp-connect-docs side.

Diff

One line.

- - url: https://github.com/redpanda-data/documentation
+ - url: https://github.com/redpanda-data/docs

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 a redpanda-data/documentation/issues URL. Cosmetic; the redirect still works for users clicking the link.
  • .github/pull-request-template.md — contains a redpanda-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.yml is at redpanda-data/cloud-docs#615.

🤖 Generated with Claude Code

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>
@Feediver1 Feediver1 requested a review from a team as a code owner June 10, 2026 19:15
@netlify

netlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-connect ready!

Name Link
🔨 Latest commit 5dd2551
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-connect/deploys/6a29b7cee9700f0008e98cbe
😎 Deploy Preview https://deploy-preview-440--redpanda-connect.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2b561f96-9bf8-476f-bbba-5d74f464b60a

📥 Commits

Reviewing files that changed from the base of the PR and between 2796d9a and 5dd2551.

📒 Files selected for processing (1)
  • local-antora-playbook.yml

📝 Walkthrough

Walkthrough

This PR updates the Antora playbook configuration to reference a different upstream Git repository for documentation content. The content.sources entry in local-antora-playbook.yml now points to https://github.com/redpanda-data/docs instead of https://github.com/redpanda-data/documentation, while all other configuration settings remain unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • JakeSCahill
  • micheleRP
  • paulohtb6
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating a documentation source URL from 'documentation' to 'docs' in the playbook file.
Description check ✅ Passed The description is well-detailed, explaining the why (repo rename, cache key issues), the what (one-line URL change), verification context, and scope limitations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-stale-docs-repo-url

Comment @coderabbitai help to get the list of available commands and usage tips.

@JakeSCahill JakeSCahill merged commit a0bbea0 into main Jun 16, 2026
6 checks passed
@JakeSCahill JakeSCahill deleted the fix-stale-docs-repo-url branch June 16, 2026 15:21
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