Regenerate CRD reference with the Pipeline CRD - #1830
Conversation
Regenerated with the same GA ignore config as before. Operator main now includes the merged Pipeline CRD (redpanda-operator#1677), which ships as a beta feature of the 26.2 operator, so the reference gains the Pipeline types alongside the existing Stretch Cluster and ShadowLink types.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
- Monitoring re-verified against merged operator main on kind v1.34 with the Prometheus Operator installed: the operator renders a PodMonitor per pipeline with monitoring enabled, Prometheus reports the pipeline target healthy on port 4195, and the input_received metric flows. - Link the Pipeline resource reference to the generated CRD reference in the streaming docs (redpanda-data/docs#1830).
Restore the full guide and the autoscaling page. The Pipeline resource is an operator CRD, and every other operator CRD guide lives here alongside the generated CRD reference, so this component owns the canonical how-to. The Redpanda Connect install section keeps a discovery page that links here (rp-connect-docs#457). Link the Pipeline CRD reference anchor directly (lands with #1830).
Restore the full guide and the autoscaling page. The Pipeline resource is an operator CRD, and every other operator CRD guide lives here alongside the generated CRD reference, so this component owns the canonical how-to. The Redpanda Connect install section keeps a discovery page that links here (rp-connect-docs#457). Link the Pipeline CRD reference anchor directly (lands with #1830).
Feediver1
left a comment
There was a problem hiding this comment.
PR Review (docs-team-standards final pass)
Files reviewed: 1 generated file (modules/reference/pages/k-crd.adoc, +446/−56)
Overall assessment: Structurally clean regen — all existing content and anchors preserved, Pipeline types correctly added and wired. One genuine defect: a broken cross-component xref inside the new Pipeline content, which needs an upstream-aware fix.
Jira ticket alignment
DOC-2275 (RPCN Operator, ENG-1184): delivers the reference third of the three-PR set (this → docs#1808 → rp-connect-docs#457).
Critical (must fix)
- [k-crd.adoc, new Pipeline content] Broken cross-component xref:
See: xref:redpanda-connect:configuration/secrets.adoc[]. Two errors: the Connect component is namedconnect(notredpanda-connect— per rp-connect-docsantora.yml, and this repo's six existing cross-refs all usexref:connect:...), and the module coordinate needs a colon, not a slash. As written, Antora looks for aredpanda-connectmodule inside the streaming component and renders a broken link.
Fix:xref:connect:configuration:secrets.adoc[](target page verified to exist). Since this text comes from the operator godoc, the durable fix is upstream in redpanda-operator + regen; given the 26.2 promotion timing, hand-patching here plus filing the upstream fix is pragmatic — otherwise the next regen reintroduces it.
Suggestion
- The PR body's stray-branch cleanup note is stale:
doc-2333-shadowlink-sr-rolesno longer exists on the remote. Drop the note.
Verified
- The 56 removed lines are all cosmetic (upstream godoc gained trailing periods); every existing type description survives intact, and no unexpected types leak in — consistent with the "same GA ignore config as #1817" claim.
- Zero anchors removed, so no existing xrefs anywhere can break. Seven Pipeline-family anchors added and correctly wired into the resource-type lists.
- The exact anchor rp-connect-docs#457 depends on is present (
:anchor_prefix: k8s-api+…-v1alpha2-pipeline), and all in-page type references resolve — includingValueSource, which pre-exists onbetafrom an earlier regen. - Legacy xref targets in re-added lines (for example
manage-topics.adoc) resolve via page-aliases — checked, not assumed. - Impact on other files: none beyond what companion #1808 covers (it adds the Pipeline row with beta badge to
k-crd-index.adocand the operator release-notes entry).
🤖 Generated with Claude Code
Feediver1
left a comment
There was a problem hiding this comment.
Looks like you need to fix a link.
urlToXref converted the godoc URL https://docs.redpanda.com/redpanda-connect/configuration/secrets/ into xref:redpanda-connect:configuration/secrets.adoc, treating the site URL slug as a module in the streaming component. The Connect component is named 'connect', so the correct resource ID is xref:connect:configuration:secrets.adoc.
|
Fixed in 5bc9019 — thanks @Feediver1. The broken link: in the new Pipeline Fix: Upstream origin (so the next regen doesn't reintroduce it): the operator godoc is actually fine — |
Regenerates
k-crd.adocfrom current operator main with the same GA ignore config used for #1817. Operator main now includes the merged Pipeline CRD (redpanda-operator#1677, beta in the 26.2 operator), so the reference gains the Pipeline types alongside the existing Stretch Cluster and ShadowLink types. The Redpanda Connect operator guide (rp-connect-docs#457) links to the new Pipeline anchor.Note: the
doc-2333-shadowlink-sr-rolesbranch got accidentally recreated on the remote when this commit was first pushed there after #1817 merged; it can be deleted (git push origin --delete doc-2333-shadowlink-sr-roles).🤖 Generated with Claude Code