docs: surface Redpanda Connect pipelines for operator users (DOC-2275)#1808
Draft
JakeSCahill wants to merge 2 commits into
Draft
docs: surface Redpanda Connect pipelines for operator users (DOC-2275)#1808JakeSCahill wants to merge 2 commits into
JakeSCahill wants to merge 2 commits into
Conversation
Three discovery surfaces for the 26.2 Pipeline CRD (DOC-2275): - new Manage > Kubernetes page routing to the full guide in the Connect docs, positioned next to Manage Kafka Connect - Pipeline row in the CRD reference index - TIP on Manage Kafka Connect pointing at the first-class alternative
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DRAFT: hold until the Pipeline CRD ships in a released operator and redpanda-data/rp-connect-docs#457 is published.
Operator users currently have no way to discover the new Pipeline resource from the Streaming docs: the Manage > Kubernetes nav lists Manage Topics and (community-supported) Manage Kafka Connect, but not the first-class Connect option. This PR adds three discovery surfaces:
manage:kubernetes/k-connect-pipelines.adoc(nav: "Redpanda Connect Pipelines", next to Manage Kafka Connect): short concept page covering what the Pipeline resource is, when to choose it over Kafka Connect, and routing to the full guide in the Connect docs (xref:connect:install:kubernetes-operator.adoc[]).reference:k-crd-index.adocwith source-file link and cross-link to the guide.Build note
Antora reports two expected broken-xref warnings for
connect:install:kubernetes-operator.adocbecause that page lives in the unmerged rp-connect-docs#457. They resolve when that PR merges.Before un-drafting (GA batch, with rp-connect-docs#457)
Part of DOC-2275; eng feature is redpanda-operator#1677.