Skip to content

Source the Connect reference partials from the Connect release asset - #309

Merged
JakeSCahill merged 6 commits into
mainfrom
docs/source-connect-partials
Oct 10, 2026
Merged

JakeSCahill merged 6 commits into
mainfrom
docs/source-connect-partials

Conversation

@JakeSCahill

@JakeSCahill JakeSCahill commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

Registers the modify-connect-tag-playbook extension so the Connect reference partials (fields, examples, metadata, descriptions, and the Bloblang reference) come from the latest Connect release instead of rp-connect-docs.

Connect no longer commits its generated docs. Each Connect release attaches them as redpanda-connect-docs.tar.gz, and the extension downloads that asset and adds the files to the connect component. This playbook doesn't list the connect repo as a content source.

Notes:

  • Bumped to docs-extensions-and-macros 5.54.0, which includes feat(rpcn-docs): source connect reference docs from the release asset docs-extensions-and-macros#358 (the asset mode), so the extension takes effect as soon as this merges.
  • Drops modify-redirects, which docs-extensions-and-macros no longer ships, so requiring it fails the build.
  • Registers set-available-attachment-versions, as docs-site does, so the Bloblang playground's connect-json-url points at the newest connect-<version>.json that exists instead of one auto-docs hasn't generated yet.
  • Merge this before redpanda-data/rp-connect-docs#531, which removes the partials rp-connect-docs still commits.

@netlify

netlify Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for redpanda-labs-preview ready!

Name Link
🔨 Latest commit e2385a2
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-labs-preview/deploys/6ac916d041956e0008ab6f53
😎 Deploy Preview https://deploy-preview-309--redpanda-labs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@JakeSCahill
JakeSCahill marked this pull request as ready for review September 27, 2026 18:06
5.52.0 has the modify-connect-tag-playbook version that keeps only the
generated partials and examples from the connect source.
docs-extensions-and-macros removed it in 5.30.0. Antora's own redirect
producer runs on every build without an extension.
…ease asset

Connect no longer commits its generated docs, so its next release has no
docs/antora.yml and Antora would fail to aggregate the source. The
modify-connect-tag-playbook extension adds the partials from the release
asset instead, once docs-extensions-and-macros ships that mode.
@JakeSCahill JakeSCahill changed the title Add the connect repo as a content source for Connect reference partials Source the Connect reference partials from the Connect release asset Oct 7, 2026
@Feediver1

Copy link
Copy Markdown
Contributor

Heads-up: please hold this PR until redpanda-data/docs-extensions-and-macros#358 is released.

redpanda-data/connect#4863 merged today, so upcoming Connect releases will no longer include docs/antora.yml. They attach the generated docs as a redpanda-connect-docs.tar.gz release asset instead. On d-e-m 5.52.0, this PR's url: https://github.com/redpanda-data/connect / tags: latest source gets pinned to the newest release. Once that release lacks docs/antora.yml, Antora stops with "antora.yml not found". After #358 ships, the extension reads the release asset and the content source is no longer needed.

So once #358 is released, this PR can drop the connect content-source lines, keep only the modify-connect-tag-playbook registration, and bump to that release.

@JakeSCahill
JakeSCahill marked this pull request as draft October 8, 2026 18:03
@JakeSCahill
JakeSCahill marked this pull request as ready for review October 9, 2026 15:36

@Feediver1 Feediver1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@Feediver1

Copy link
Copy Markdown
Contributor

Technical check: Connect release-asset cutover

Overall: Ready to merge. Everything my 10/8 hold waited on has shipped, and the preview builds cleanly. This one has a larger version jump than its siblings (redpanda-data/docs#2117, redpanda-data/cloud-docs#748, redpanda-data/adp-docs#356), and an extra playbook change that's needed for it to build.

Hold conditions: all met

Condition Status
redpanda-data/connect#4876 Merged 10/8
Connect release with the asset v4.113.0 (10/9)
redpanda-data/docs-extensions-and-macros#358 released In v5.54.0
Content-source lines dropped Done (2f05875c); the playbook lists only rp-connect-docs
Bump 3d24e3ff: the lockfile moves from 5.0.0 to 5.54.0

Suggestions

  1. The PR body is out of date and doesn't mention the modify-redirects removal. The first "Before merging" bullet still asks for the bump. 1b82b7c4 also changes the build, so the body should say why. Consider: "Bumped to 5.54.0 (includes #358). Also drops modify-redirects, which d-e-m no longer ships, so requiring it fails the build." Dropping it loses nothing: the playbook has no redirect_facility, and neither the preview nor main serves a _redirects file.

  2. Not caused by this PR: the same Bloblang JSON 404 as the sibling PRs. The playbook doesn't register set-available-attachment-versions, so connect-json-url points to the not-yet-generated connect-4.113.0.json. Consider adding it here or in a follow-up.

Impact on other repos

  • redpanda-data/rp-connect-docs#531: the same note as on the sibling PRs. The release asset doesn't include connect-<version>.json, so that file still depends on rp-connect-docs' auto-docs regen after the cutover.

What works well

  • The jump from 5.0.0 to 5.54.0 didn't break anything I sampled. Every sitemap except Cloud and Streaming has the same page count on the preview and main (Connect 411, labs 34). Six pages return 200 with no unresolved includes: three Connect pages and three labs pages (cloud-go, docker-python, ts-converter-rust). All three labs pages have the same anchor-ID counts on both builds. The small differences in the Cloud (+41) and Streaming (+2) sitemaps, and two IDs on kafka_franz, come from other repos' content: the labs main preview was last built 9/4.
  • The compatibility requirements are met. d-e-m 5.54.0 needs Node ≥18 and @antora/* ^3.1.0, which the pinned Antora 3.1.2 meets.
  • Correct extension order: modify-connect-tag-playbook comes before generate-rp-connect-info.
  • The lockfile churn is harmless. The ~2,400 deleted lines are transitive appium-driver devDependencies.

@JakeSCahill

Copy link
Copy Markdown
Contributor Author

Thanks @Feediver1. Updated the description, and e2385a2 registers set-available-attachment-versions after the version fetcher, as docs-site does, so connect-json-url points at the newest connect-<version>.json that exists.

@micheleRP micheleRP left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Lockfile resolves docs-extensions-and-macros 5.54.0, and the playbook only affects PR previews.

@JakeSCahill
JakeSCahill merged commit 4724f7c into main Oct 10, 2026
6 checks passed
@JakeSCahill
JakeSCahill deleted the docs/source-connect-partials branch October 10, 2026 09:42
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.

3 participants