Docs site restructure to support ADP and Data Platform users#173
Merged
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
Contributor
Author
|
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>
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 all 8 Critical items in the review comment above are addressed before merge: delete INTERIM-HOME-PAGE.md + test-unified-nav.yml, unpin package.json:20 from the feature branch, repoint redpanda-labs in the playbook, fix the 3 broken xrefs (cloud-data-platform:ROOT:index.adoc → :home:; the two streaming:deploy:deployment-option/self-hosted/... paths), strip the em dash in the self-managed hero description, replace the /Users/jakecahill/... paths in local-antora-playbook.yml. Cross-rollout notes (merge order, verification, coordination items) are appended to the comment for your reference.
- Fixed component metadata colors to match design system color wheel - Fixed redpanda-labs branch reference (main → feature/page-header-data) - Fixed broken xrefs in home and self-managed components - Fixed em dash style violation in self-managed - Updated netlify.toml with new component names and redirects - Updated llms.adoc paths from /current/ to /streaming/ - Moved INTERIM-HOME-PAGE.md to meta-docs/WIP-INTERIM-HOME-PAGE.md - Deleted test-unified-nav.yml (personal dev playbook) - Fixed local-antora-playbook.yml hardcoded paths Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Fix xrefs in playbooks to include component prefixes - Update local playbook to use relative extension paths - Move MCP setup doc from page-navigation to traditional nav - Add popular guide links in data-platform index - Update streaming xrefs to include /current/ version segment - Update self-managed hero gradient color - Remove versioning section from llms.adoc Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Changed page-navigation config to include data-platform as a parent node with children, matching the pattern used by home component. This ensures parent nav items appear above child component buckets. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Create new page in data-platform component explaining docs structure - Address product naming changes (Self-Managed vs Streaming) - Consolidate all AI agent access features into single section: - llms.txt and llms-full.txt discovery files - Page options (View/Copy as Markdown, Ask AI) - MCP server setup (merged from mcp-setup.adoc) - Static markdown exports - Individual page fetching - Update navigation in data-platform and home components - Update MCP endpoint redirects to point to new page - Remove old mcp-setup.adoc (redirected via page-aliases) - Update to docs-extensions-and-macros v5.0.0 (npm package) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Regenerate package-lock.json from scratch to include all platform-specific optional dependencies required for CI builds. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add catch-all redirects for /current/*, /redpanda-connect/*, /redpanda-cloud/*, and /redpanda-labs/* to ensure all old URLs redirect to new component paths. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
The header widget no longer has an inline style attribute, so change the regex to ADD the style attribute instead of replacing an existing background-color value. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Apply 8% component color mixed with white for subtle topbar tint: - Cloud APIs: color-mix(in srgb, #1D4ED8 8%, white) - Self-Managed APIs: color-mix(in srgb, #9F1239 8%, white) Co-Authored-By: Claude Opus 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
4 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 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: