Skip to content

fix: stop requiring the drifted redirect-producer fork - #4

Closed
JakeSCahill wants to merge 1 commit into
mainfrom
fix/use-real-redirect-producer
Closed

JakeSCahill wants to merge 1 commit into
mainfrom
fix/use-real-redirect-producer

Conversation

@JakeSCahill

Copy link
Copy Markdown
Contributor

Summary

  • Removes the require: '@redpanda-data/docs-extensions-and-macros/extensions/modify-redirects' line from this repo's Antora playbook.

Why

docs-extensions-and-macros#273 deletes the hand-rolled produce-redirects.js fork and its ./extensions/modify-redirects export subpath — Antora's own site-generator already calls the real @antora/redirect-producer unconditionally, so the fork was redundant (and had drifted a real bug: it didn't unpublish self-referential aliases the way upstream does).

Once that version is published, any build that still requires the deleted subpath fails immediately with ERR_PACKAGE_PATH_NOT_EXPORTED, before rendering a single page. This was found by a real Antora build against the full playbook, not just docs-extensions-and-macros' own unit tests (which don't exercise any downstream playbook).

Confirmed via gh api that this line is still present in six repos today; docs (#1960), cloud-docs (#689), and redpanda-labs (#295) already have this exact fix open. This PR covers this repo.

Test plan

  • Verify the Antora build still succeeds after this line is removed (no facility change needed — the built-in redirect-producer runs automatically either way).
  • Merge alongside or after docs-extensions-and-macros#273, not before it also lands.

Antora's own site-generator already calls the real @antora/redirect-producer
unconditionally. docs-extensions-and-macros#273 deletes the hand-rolled fork
and its ./extensions/modify-redirects export subpath; this playbook still
requires that subpath, so the next Antora build after that version lands
would fail with ERR_PACKAGE_PATH_NOT_EXPORTED.
@Feediver1

Copy link
Copy Markdown
Contributor

PR review: fix: stop requiring the drifted redirect-producer fork (#4)

Overall assessment: Superseded. This PR can be closed.

  • The change is already on main. Source the Connect reference partials from the Connect release asset #5 ("Source the Connect reference partials from the Connect release asset", 2026-10-10) removed the modify-redirects line from local-antora-playbook.yml.
  • Merging would change nothing. A test merge into current main applies cleanly but leaves the files identical to main. Nothing else in the repo still references modify-redirects.
  • The reason for it holds. docs-extensions-and-macros#273 merged on 2026-09-01, and this repo depends on @redpanda-data/docs-extensions-and-macros ^5.55.0, so the line had to go. It's gone.

Sibling PRs: docs#1960 and cloud-docs#689 are merged. redpanda-labs#295 is still open. If redpanda-labs still requires extensions/modify-redirects, its builds will fail with ERR_PACKAGE_PATH_NOT_EXPORTED once they pick up a docs-extensions-and-macros version without it. That's the one worth following up.

Review using the docs-team-standards antora-conventions skill.

@JakeSCahill

Copy link
Copy Markdown
Contributor Author

Closing as superseded: #5 already removed the modify-redirects line from local-antora-playbook.yml on main, so this PR no longer changes anything.

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