Skip to content

Add unified navigation test playbook and umbrella components#173

Open
JakeSCahill wants to merge 15 commits into
mainfrom
feature/unified-navigation-playbooks
Open

Add unified navigation test playbook and umbrella components#173
JakeSCahill wants to merge 15 commits into
mainfrom
feature/unified-navigation-playbooks

Conversation

@JakeSCahill
Copy link
Copy Markdown
Contributor

@JakeSCahill JakeSCahill commented May 12, 2026

Adds a single consolidated test playbook for unified navigation testing with all remote feature branches.

Changes

New Test Playbook: test-unified-nav.yml

Replaces 4 separate test playbooks with one comprehensive testing configuration:

Content Sources (Remote Feature Branches):

  • docs: feature/page-header-data (main) + 7 version branches
    • feature/rename-streaming-23.3
    • feature/rename-streaming-24.1
    • feature/rename-streaming-24.2
    • feature/rename-streaming-24.3
    • feature/rename-streaming-25.1
    • feature/rename-streaming-25.2
    • feature/rename-streaming-25.3
  • cloud-docs: feature/component-home-v3
  • rp-connect-docs: feature/unified-navigation
  • redpanda-labs: HEAD (local)
  • adp-docs: HEAD (local)

Extensions:

  • Unified navigation extension (local path for testing)
  • All essential extensions for full functionality

Start Page: data-platform::index.adoc (Data Platform landing page)

New Umbrella Components

data-platform/

Data Platform umbrella component:

  • Overview page with navigation to Streaming and Connect
  • Minimal nav structure
  • Enables unified sidebar aggregation

self-managed/

Self-Managed parent component:

  • Overview page for hierarchical organization
  • Minimal nav structure
  • Parent for Streaming and Connect in hierarchy

Removed Playbooks

Deleted 4 separate test playbooks:

  • ❌ test-cloud-only.yml
  • ❌ test-labs-playbook.yml
  • ❌ test-multicomponent-playbook.yml
  • ❌ test-simple-playbook.yml

Usage

# Build with test playbook
npx antora test-unified-nav.yml

# Preview
npx http-server build/site -p 8000

Navigate to http://localhost:8000/data-platform/ to see unified navigation with:

  • Data Platform landing page
  • Unified sidebar with Streaming + Connect buckets
  • Per-bucket version selectors (7 versions for Streaming)
  • Component theming and icons

Related PRs

Extension & UI

Content Repositories

Testing Coverage

This playbook enables testing of:

  • ✅ Unified sidebar with multiple buckets (Streaming, Connect)
  • ✅ Component theming (colors, icons)
  • ✅ Per-bucket version selectors
  • ✅ Bucket expand/collapse
  • ✅ Component home v3 layouts
  • ✅ Data Platform landing page
  • ✅ All 7 renamed version branches
  • ✅ Product switcher with umbrella hierarchy
  • ✅ Navigation aggregation from child components

@JakeSCahill
Add unified navigation test playbook and umbrella components
07eb1d9 
- 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.
@JakeSCahill JakeSCahill requested a review from a team as a code owner May 12, 2026 10:38
@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026 •
edited
Loading

❌ Deploy Preview for redpanda-documentation failed. Why did it fail? →

Name Link
🔨 Latest commit c398eac
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-documentation/deploys/6a0770bdfa36a4000821516a

@JakeSCahill
Use git reference for unified-navigation extension
8d13500 
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.
@JakeSCahill
Use git reference for unified-navigation extension testing
e6b41b9 
- Update @redpanda-data/docs-extensions-and-macros to git reference
- Points to feature/unified-navigation branch for testing
- Lock dependencies with package-lock.json
@JakeSCahill
Fix glob overflow by using remote URLs for labs and adp-docs
22ff2ee 
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.
@JakeSCahill
Upgrade Antora to 3.1.14 to fix glob overflow with local repos
381965f 
- 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
@JakeSCahill
Copy link
Copy Markdown
Contributor Author

JakeSCahill commented May 12, 2026 •
edited by atlassian Bot
Loading

Jira: DOC-2180

JakeSCahill and others added 10 commits May 12, 2026 12:41
@JakeSCahill
Update test playbook to use local repos for all components
b8698a0 
- 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
@JakeSCahill
Add version branches to test playbook for multi-version navigation
481a4f7
@JakeSCahill @claude
Fix heading case on self-managed landing page
17e33f7 
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>
@JakeSCahill @claude
Rename Redpanda Self-Managed to Redpanda Streaming
74bbfe7 
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@JakeSCahill @claude
Fix data platform page resource ID paths
b4dbb96 
- 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>
@JakeSCahill @claude
Rename page-header-data to component-metadata in antora.yml files
c6b6d77 
- 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>
@JakeSCahill @claude
Update home page content and layout
ef8e007 
- 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>
@JakeSCahill @claude
Add quickstart link to self-managed navigation
6c2f536 
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@JakeSCahill @claude
Update playbooks to use v3.0.0-beta1 UI and WIP content branches
e0b44f6 
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>
@JakeSCahill @claude
Fix extensions dependency for Netlify preview builds
c398eac 
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JakeSCahill