Skip to content

Add unified navigation test playbook and umbrella components#173

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

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

Conversation

@JakeSCahill
Copy link
Copy Markdown
Contributor

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

- 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

Deploy Preview for redpanda-documentation ready!

Name Link
🔨 Latest commit 74bbfe7
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-documentation/deploys/6a034c155bd11900084e04eb
😎 Deploy Preview https://deploy-preview-173--redpanda-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 94 (🟢 up 12 from production)
Accessibility: 96 (no change from production)
Best Practices: 100 (no change from production)
SEO: 83 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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
@JakeSCahill
Copy link
Copy Markdown
Contributor Author

JakeSCahill commented May 12, 2026

Jira: DOC-2180

JakeSCahill and others added 4 commits May 12, 2026 12:41
- 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant