Docs site restructure to support ADP and Data Platform users#173
Docs site restructure to support ADP and Data Platform users#173JakeSCahill wants to merge 37 commits into
Conversation
- Add test-unified-nav.yml: Single test playbook for unified navigation - Uses remote feature branches from all repos - Includes all 7 version branches: v23.3, v24.1-24.3, v25.1-25.3 - References unified-navigation extension - Starts at data-platform landing page - Add data-platform umbrella component - Overview page with links to child components - Minimal navigation structure - Add self-managed parent component - Overview page for Self-Managed hierarchy - Minimal navigation structure - Remove old test playbooks (test-cloud-only, test-labs, test-multicomponent, test-simple) This playbook enables testing of the complete unified navigation implementation with all remote feature branches.
✅ Deploy Preview for redpanda-documentation ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Change from local path to git+https reference so the playbook can be used by anyone without needing the local extension repo. References feature/unified-navigation branch directly from GitHub.
- Update @redpanda-data/docs-extensions-and-macros to git reference - Points to feature/unified-navigation branch for testing - Lock dependencies with package-lock.json
The glob stack overflow was caused by using local filesystem paths which exposed node_modules with circular symlinks (109 in adp-docs, many in labs Chrome Framework). Using remote GitHub URLs fixes this because git repos don't include node_modules, eliminating the circular reference issue. Changes: - redpanda-labs: local path → github.com/redpanda-data/redpanda-labs - adp-docs: local path → github.com/redpanda-data/adp-docs Unified navigation extension now loads successfully.
- Upgraded @antora/cli and @antora/site-generator from 3.1.2 to 3.1.14 - Changed test playbook to use local paths for all repos - Added exclude patterns for node_modules (though upgrade made them unnecessary) - This allows testing local repos without glob stack overflow from circular symlinks - Build now progresses to show actual include errors that need fixing
|
Jira: DOC-2180 |
- Using local paths for docs, cloud-docs, rp-connect-docs, labs, adp-docs - This allows testing xref fixes locally before pushing - Antora 3.1.14 handles local repos without glob overflow - Build completes successfully with unified navigation
Use sentence case for section headings: - "Choose Your Component" → "Choose your component" - "Deployment Options" → "Deployment options" Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Change colons to forward slashes for subdirectory paths - Fix BYOC link: cluster-types/byoc/index.adoc (was cluster-types:byoc:index.adoc) - Fix Connect quickstart: get-started/quickstarts/index.adoc - Fix producer/consumer config paths with forward slashes - Fix schema registry path: manage/schema-reg/index.adoc All links now resolve correctly from versionless data-platform component. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- More accurate name: this is component-level metadata, not page-level - Update all three umbrella components: home, data-platform, self-managed - Remove section field (deprecated - breadcrumbs now use page-navigation config) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Add expand-buckets attribute for ADP bucket - Add hero section with eyebrow, title, subtitle - Add intent cards section (Data Platform and ADP) - Add products section with component cards - Swap intent cards: ADP first, then Data Platform - Swap product cards: ADP first in hierarchy Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Changes to all three playbooks (preview, local, antora): UI Bundle: - Use v3.0.0-beta1 beta release (includes breaking changes) - Cloud/Self-Managed card swap on Data Platform page - component-metadata rename (was page-header-data) - Config-driven unified navigation Content Sources: - Add data-platform and self-managed umbrella components - Use feature/rename-streaming-main branch for current docs - Use feature/rename-streaming-* branches for versioned docs (23.3-25.3) - Use feature/component-home-v3 for cloud-docs - Use feature/unified-navigation for rp-connect-docs - Use feature/platform-badges for adp-docs Extensions: - Add unified-navigation extension (config-driven architecture) - Extensions loaded from local file path (feature/unified-navigation branch) Testing: - All WIP branches contain component-metadata (not page-header-data) - All umbrella components have page-navigation config - Breadcrumb hierarchy computed from navigation tree Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Change from local file path to GitHub branch reference: - Was: file:../docs-extensions-and-macros (only works locally) - Now: github:redpanda-data/docs-extensions-and-macros#feature/unified-navigation This allows Netlify to fetch the extensions package from GitHub during preview builds, using the WIP feature/unified-navigation branch. Also update test playbook: - Fix start_page: home::index.adoc (was data-platform) - Add shared branch for global attributes Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Fix mobile nav collapse/reopen bug - Improve light mode expand button visibility - Make topbar fully opaque for better readability - Reduce gap in mobile nav Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Regenerate lock file to fix afdocs CI check. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Point to feature/page-header-data branch in redpanda-labs which has the component renamed from 'redpanda-labs' to 'labs'. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Required for search to work with renamed components. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Upgrade Node from 20 to 22 (required by dependencies) - Add NODE_OPTIONS with 6GB heap size for Algolia indexer Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
| // === CLOUD CARD === | ||
| :page-cloud-title: Cloud | ||
| :page-cloud-tagline: Streaming, fully managed. | ||
| :page-cloud-description: Spin up a cluster in minutes. We handle upgrades, scaling, and failover: you bring the data. Available as Dedicated, Serverless, or Bring Your Own Cloud. |
There was a problem hiding this comment.
| :page-cloud-description: Spin up a cluster in minutes. We handle upgrades, scaling, and failover: you bring the data. Available as Dedicated, Serverless, or Bring Your Own Cloud. | |
| :page-cloud-description: Spin up a cluster in seconds. We handle upgrades, scaling, and failover: you bring the data. Available as Serverless, Dedicated, or Bring Your Own Cloud (BYOC). |
| :page-cloud-bullet2: AWS, GCP, Azure | ||
| :page-cloud-bullet3: 24/7 SRE on call | ||
| :page-cloud-stat1-number: 99.99% | ||
| :page-cloud-stat1-text: SLA on Dedicated |
There was a problem hiding this comment.
| :page-cloud-stat1-text: SLA on Dedicated | |
| :page-cloud-stat1-text: SLA on BYOC & Dedicated |
|
footer/copyright missing |
|
The back button is not working from Labs |
|
Some comments about these Cloud links: |
|
In the Build agentic data flows there is a link: Get started with ADP. Shouldn't this be Get started with Redpanda Agentic Data Plane (ADP)? |
|
Overall, there is a great deal of empty/white space on https://deploy-preview-173--redpanda-documentation.netlify.app/home/. |
|
The PREV and NEXT text in these wide cells sits adjacent to the border--this just doesn't look right--a big empty cell with lots of room, but the text scrunched up nearly flush with the border. Can you pull it in a space or two? |
|
https://deploy-preview-173--redpanda-documentation.netlify.app/cloud-data-platform/home/
|
https://deploy-preview-173--redpanda-documentation.netlify.app/data-platform/#
|
Troubled by all of the underlined content here.
|
|
https://deploy-preview-173--redpanda-documentation.netlify.app/data-platform/ |
|
https://deploy-preview-173--redpanda-documentation.netlify.app/connect/get-started/quickstarts/ |
|
Why @micheleRP? |
because they look and feel different |
that's an icon. It's meant to represent a terminal prompt. |






















Adds a new architecture for the docs site to support two platforms: ADP and Data Platform
Related PRs
Extension & UI
Content Repositories
Testing Coverage
This playbook enables testing of: