Add unified navigation attributes and rename component#427
Open
JakeSCahill wants to merge 15 commits into
Open
Add unified navigation attributes and rename component#427JakeSCahill wants to merge 15 commits into
JakeSCahill wants to merge 15 commits into
Conversation
- Rename component from redpanda-connect to connect - Add page-header-data attributes for unified navigation: - title, section, parent-component, description - Add icon: plug-connected for bucket display Part of unified navigation implementation.
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedToo many files! This PR contains 300 files, which is 150 over the limit of 150. To get a review, narrow the scope: ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (300)
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 |
Contributor
Author
|
Jira: DOC-2180 |
- Updated xrefs: redpanda-connect → connect - Updated xrefs: redpanda-cloud → cloud-data-platform - Updated xrefs: redpanda-labs → labs - Updated self-references: ROOT → streaming - Fixed references in both .adoc pages and .json attachments
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Update to match new naming convention for component metadata. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Change redpanda-cloud: to cloud-data-platform: in antora.yml and overrides.json Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…o connect Updated overrides.json to use correct component name in include directives. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…ect to connect Replaced all occurrences of include::redpanda-connect:components:partial$secret_warning.adoc with include::connect:components:partial$secret_warning.adoc in auto-generated field partial files. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Convert from minimal component-home-v2 to full-featured component-home-v3 layout with hero, deploy options, popular topics, and labs sections. Sections added: - Hero with description - Deploy section: rpk, Helm, Binary installation - Popular topics: Connectors, Bloblang, CDC, RAG & AI - Labs section (title only, no items yet) Removes duplicate page-role attribute (layout handles this automatically).
Defines 4 Connect-specific AI suggestion questions that appear in the Ask AI chat drawer when viewing Connect documentation. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Keep component-metadata structure (renamed from page-header-data) - Accept auto-generated connector docs from main (v4.91.0) - Remove salesforce processor page (moved to input connectors)
Replace all references to redpanda-connect: with connect: to match the actual component name used in the documentation site. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
micheleRP
reviewed
May 22, 2026
Contributor
There was a problem hiding this comment.
Review
Critical
-
local-antora-playbook.yml:3still hasstart_page: redpanda-connect:home:index.adoc. Component is nowconnect. Local builds (npm run build) will fail with a missing start page. Fix:start_page: connect:home:index.adoc. -
docs-data/overrides.json:621(thegatewayinput description) still containsxref:redpanda-connect:components:inputs/http_server.adoc. The same description had itsredpanda-cloud:ref updated tocloud-data-platform:on the same line, so theredpanda-connect:miss is a sed gap. Next regen will publish a broken xref. Fix: swap toxref:connect:components:inputs/http_server.adoc. -
modules/components/attachments/connect-4.91.0.json:7905carries the same staleredpanda-connect:xref. Generated artifact; whatever generation step produced it needs to be re-run after the overrides fix in #2. -
Product-name string changes that don't belong in a "rename component" PR.
modules/get-started/pages/whats-new.adoc:1461now says "Redpanda Connect has been GA in Redpanda Streaming clusters since version 4.29.0" (was "Redpanda Self-Managed clusters").modules/get-started/pages/versioning.adoc:17now says "versioning of other Redpanda Streaming products" (was "Redpanda Self-Managed products").
The component rename targeted xref prefixes only — these are a customer-facing product naming change that doesn't belong here and may not match what's launching. Fix: confirm with stakeholders or revert these two lines.
Suggestions
modules/home/pages/index.adocuses:page-popular-3-title: Change Data Capture(Title Case) and:page-popular-4-title: RAG & AI Pipelines(Title Case + ampersand). Both render as card titles — sentence case is normal for cards. Suggest:Change data capture,RAG and AI pipelines.
Content sweep (~450 files)
Almost entirely mechanical sed-style rewrites of include::redpanda-connect: → include::connect:, xref:ROOT: → xref:streaming:, and redpanda-cloud: → cloud-data-platform: in module pages, partials, and field reference partials. Bloblang functions/methods pages, all component pages, get-started pages — all touched but content-identical otherwise. No AsciiDoc syntax issues spotted. The two prose changes in whats-new.adoc and versioning.adoc flagged above are the only substantive copy edits.
Coordination risk
- Uses
component-metadatainantora.yml(consistent withdocsredpanda-data/docs#1698-redpanda-data/docs#1705 andcloud-docsredpanda-data/cloud-docs#578). include::streaming:...requires thedocsrename PRs to merge.xref:cloud-data-platform:...requirescloud-docsredpanda-data/cloud-docs#578 to rename.
See docs-site redpanda-data/docs-site#173 for cross-rollout notes (suggested approval order + verification steps).
This was referenced May 22, 2026
micheleRP
approved these changes
May 22, 2026
Contributor
micheleRP
left a comment
micheleRP
left a comment
There was a problem hiding this comment.
Approved on the assumption that the 4 Critical items in the review comment above are addressed before merge: (1) fix start_page in local-antora-playbook.yml:3 from redpanda-connect: to connect:, (2) fix the stale redpanda-connect: xref in docs-data/overrides.json:621 (gateway input), (3) regen modules/components/attachments/connect-4.91.0.json to pick up the overrides fix, (4) revert or stakeholder-confirm the two 'Self-Managed clusters' → 'Streaming clusters' / 'Self-Managed products' → 'Streaming products' prose changes in whats-new.adoc:1461 and versioning.adoc:17 — those are a customer-facing product naming change that doesn't belong in a rename PR.
Add page-use-parent-context flag to enable hierarchical navigation with parent context cards in the UI. This shows the Self-Managed parent card with Connect as a subcard when viewing Connect pages. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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
2 participants
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.
Adds unified navigation attributes to Connect component and renames from
redpanda-connecttoconnect.Changes
Component Rename
Unified Navigation Attributes
Adds complete
page-header-dataattributes for Data Platform unified sidebar:title: "Connect" - Display namesection: "Data Platform" - Umbrella section identifierparent-component: "self-managed" - Parent hierarchydescription: "Build data pipelines with hundreds of prebuilt connectors."color: "#54478C" - Component theme color (existing)order: 3 - Sort order in unified navigation (existing)icon: "plug-connected" - Tabler icon for bucket displayRelated PRs
Antora Extension
docs Repository
docs-ui
cloud-docs
Impact
This change enables the Connect documentation to appear in the unified Data Platform sidebar with:
Testing
After merging, the Connect component will:
Breaking Changes
URL Changes
Component rename will change URLs:
/redpanda-connect/.../connect/...Redirects will be configured in docs-site to handle old URLs.