Repository navigation
Source the Connect reference partials from the Connect release asset - #309
Conversation
✅ Deploy Preview for redpanda-labs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
|
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 So once #358 is released, this PR can drop the connect content-source lines, keep only the |
Technical check: Connect release-asset cutoverOverall: 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
Suggestions
Impact on other repos
What works well
|
… at a file that exists
|
Thanks @Feediver1. Updated the description, and e2385a2 registers |
micheleRP
left a comment
There was a problem hiding this comment.
LGTM. Lockfile resolves docs-extensions-and-macros 5.54.0, and the playbook only affects PR previews.
Registers the
modify-connect-tag-playbookextension 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 theconnectcomponent. This playbook doesn't list the connect repo as a content source.Notes:
modify-redirects, which docs-extensions-and-macros no longer ships, so requiring it fails the build.set-available-attachment-versions, as docs-site does, so the Bloblang playground'sconnect-json-urlpoints at the newestconnect-<version>.jsonthat exists instead of one auto-docs hasn't generated yet.