Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
7488b94
Add BYOC and Cloud badge styles for ADP documentation
JakeSCahill Apr 22, 2026
37bacc1
Add availability block and enhance ADP page styling
JakeSCahill Apr 23, 2026
d653acd
Add BYOC and Cloud feature helpers for nav badges
JakeSCahill Apr 23, 2026
5b36bdd
Address CodeRabbit review comments
JakeSCahill Apr 24, 2026
b78c130
Remove ADP availability admonition for GA descope (#378)
micheleRP May 6, 2026
0835a20
Merge remote-tracking branch 'origin/main' into feature/badge-byoc-only
JakeSCahill May 7, 2026
a7fa000
Merge remote-tracking branch 'origin/feature/badge-byoc-only' into fe…
JakeSCahill May 7, 2026
0653386
Resolve merge conflict: keep availability block for ADP pages
JakeSCahill May 7, 2026
30917d0
Add BYOC and Cloud platform badges for ADP documentation
JakeSCahill May 7, 2026
30b5687
Implement unified navigation and Data Platform hierarchy
JakeSCahill May 12, 2026
1ece9e8
Add test screenshots to gitignore
JakeSCahill May 12, 2026
7a5a14e
Fix dropdown positioning and add component-home-v3 icons
JakeSCahill May 12, 2026
be560cc
Fix squashed icons on component landing pages
JakeSCahill May 12, 2026
b5cb928
Fix component-home-v3 icons for Connect, Kubernetes, Docker
JakeSCahill May 12, 2026
786325e
Fix intro paragraph styling to only apply to first paragraph
JakeSCahill May 12, 2026
172e667
Rename Redpanda Self-Managed to Redpanda Streaming
JakeSCahill May 12, 2026
efce87e
Add Ask AI chat persistence across page navigation
JakeSCahill May 12, 2026
b4ffe8a
Fix H1 hidden by component indicator on Bloblang playground
JakeSCahill May 12, 2026
d3bedd2
Hide component indicator on Bloblang playground
JakeSCahill May 12, 2026
d6974a3
Restore component indicator on Bloblang playground with proper spacing
JakeSCahill May 12, 2026
dc51c4d
Fix H1 title visibility on Bloblang playground
JakeSCahill May 12, 2026
35a3439
Swap Cloud and Self-Managed cards on Data Platform page
JakeSCahill May 15, 2026
60b1492
Add is-external-url helper for URL type detection
JakeSCahill May 15, 2026
3e8b5e7
Add error logging to resolve-resource helper
JakeSCahill May 15, 2026
49f4eeb
Update labs links to handle external URLs and Antora resource IDs
JakeSCahill May 15, 2026
866262a
Hide all decorative icons on Cloud landing pages
JakeSCahill May 15, 2026
41c4e3d
Hide all decorative icons on Data Platform landing page
JakeSCahill May 15, 2026
3fd7f20
Rename page-header-data to component-metadata in UI helpers
JakeSCahill May 15, 2026
60716dd
Rename page-header-data to component-metadata in templates
JakeSCahill May 15, 2026
cb9dbd5
Fix mobile nav collapse/reopen bug and improve light mode visibility
JakeSCahill May 18, 2026
5c5fd39
Fix accessibility and build issues from CodeRabbit review
JakeSCahill May 18, 2026
862085d
Fix remaining CodeRabbit review issues
JakeSCahill May 18, 2026
447f7a2
Update Algolia search to handle new umbrella components
JakeSCahill May 18, 2026
99b48a4
Fix Algolia search initialization error on pages without search conta…
JakeSCahill May 18, 2026
b59fe06
Add missing #autocomplete container for Algolia search
JakeSCahill May 18, 2026
1fc8ebd
Make topbar background solid instead of translucent
JakeSCahill May 19, 2026
d8ebb40
Fix CSS lint error: merge topbar-bg into existing theme selectors
JakeSCahill May 19, 2026
0726be3
Remove unused metadata proposal files
JakeSCahill May 19, 2026
d74f230
Fix code review findings from PR #376
JakeSCahill May 19, 2026
56f4e5d
Fix topbar transparency: use solid component-colored backgrounds
JakeSCahill May 19, 2026
636b58c
Fix Bloblang playground corner clipping issue
JakeSCahill May 19, 2026
ee470f9
Fix missing mobile nav toggle on home page
JakeSCahill May 19, 2026
edf66b5
Add NEW badge system and interim home page structure
JakeSCahill May 19, 2026
a2b964d
Make data-platform interim home page with Ask AI and SQL NEW badge
JakeSCahill May 19, 2026
616b6c8
Fix What's New styling and aggregation
JakeSCahill May 19, 2026
c0389c9
Add What's New support to component-home-v3 layout
JakeSCahill May 19, 2026
6d33233
Fix navigation system and add home component nav support
JakeSCahill May 19, 2026
c72da86
Add sparkles icon for ADP and clean up navigation debug code
JakeSCahill May 20, 2026
da12e11
Increase component home hero width to 1100px to match data-platform
JakeSCahill May 20, 2026
afae6dd
Fix critical bugs and enhance landing pages with full-width layout
JakeSCahill May 20, 2026
13dcbc4
Hide labs section when no lab items are defined
JakeSCahill May 20, 2026
c10c490
Fix AI suggestions and bold text rendering
JakeSCahill May 20, 2026
b2a1310
Remove max-width constraints from home page sections
JakeSCahill May 20, 2026
2dcaf41
Fix 'Ask AI about this topic' to open chat drawer instead of modal
JakeSCahill May 20, 2026
51ce18e
Fix mobile overflow menu visibility and click handler
JakeSCahill May 20, 2026
5d16e68
Fix version dropdown positioning on mobile in explore panel
JakeSCahill May 20, 2026
dfa4d6a
Fix version dropdown positioning on mobile in breadcrumbs
JakeSCahill May 20, 2026
5e3f125
Fix version dropdown mobile positioning in sticky header and breadcrumbs
JakeSCahill May 20, 2026
36741fa
Fix version dropdown mobile positioning by removing CSS containment
JakeSCahill May 21, 2026
0298437
Remove underlines from version dropdown and fix mobile close behavior
JakeSCahill May 21, 2026
38b2f4a
Fix home page spacing, font sizes, and add footer to landing pages
JakeSCahill May 21, 2026
1172c3a
Restructure products section with two main clickable cards
JakeSCahill May 21, 2026
c05ad1d
Enhance product cards with descriptions, GIF, and quick links
JakeSCahill May 21, 2026
fbec688
Replace ADP card GIF with adp-infographic.gif
JakeSCahill May 21, 2026
a5c8f3a
Add padding to PREV/NEXT pagination buttons
JakeSCahill May 21, 2026
27192db
Standardize font sizes to rem-based calculations with 1-2px increases
JakeSCahill May 21, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,8 @@ src/static/*
!src/static/bloblang-docs.json
test-results.*
test-results-*.*
.playwright-mcp/
.playwright-mcp/

# Test screenshots
*.png
!/src/img/*.png
194 changes: 194 additions & 0 deletions WHATS-NEW-SYSTEM.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
# What's New System Documentation

The What's New system allows components to define their latest features and have them displayed automatically on component landing pages and aggregated on the Data Platform umbrella page.

## How It Works

### For Component Writers

Define What's New items in your **component's home/landing page** (e.g., `modules/ROOT/pages/index.adoc` or `antora.yml`):

```asciidoc
= Component Home Page

// What's New Item 1
:component-whats-new-1-title: Redpanda SQL
:component-whats-new-1-desc: Query your streaming data in real-time with SQL. Run analytical queries directly on topics without ETL.
:component-whats-new-1-link: sql:index.adoc
:component-whats-new-1-tag: Cloud BYOC

// What's New Item 2
:component-whats-new-2-title: Enhanced Monitoring
:component-whats-new-2-desc: New Grafana dashboards with real-time metrics
:component-whats-new-2-link: manage:monitoring.adoc
:component-whats-new-2-tag: All Tiers

// Up to 10 items supported (component-whats-new-3-*, component-whats-new-4-*, etc.)
```

### Attribute Reference

Each What's New item requires 4 attributes (where N = 1, 2, 3... up to 10):

| Attribute | Required | Description | Example |
|-----------|----------|-------------|---------|
| `component-whats-new-N-title` | Yes | Feature title (short, punchy) | `Redpanda SQL` |
| `component-whats-new-N-desc` | Yes | Feature description (1-2 sentences) | `Query streaming data in real-time with SQL` |
| `component-whats-new-N-link` | Yes | Link to feature docs (Antora xref format) | `sql:index.adoc` |
| `component-whats-new-N-tag` | No | Badge text (platform/tier info) | `Cloud BYOC`, `Enterprise`, `All Tiers` |

### Display Locations

#### 1. Component Landing Pages (Automatic)

The What's New section automatically appears on component landing pages that use the `component-home-v2` or `component-home-v3` layout.

No template changes needed - just define the attributes and they'll show up!

**Example components:**
- `cloud-data-platform/modules/ROOT/pages/index.adoc`
- `streaming/modules/home/pages/index.adoc`
- `connect/modules/ROOT/pages/index.adoc`

#### 2. Data Platform Umbrella Page (Aggregated)

The Data Platform home aggregates What's New from multiple components:

In `data-platform/modules/ROOT/partials/data-platform.hbs`:
```handlebars
{{#with (aggregate-whats-new site "cloud-data-platform" "streaming" "connect")}}
{{> whats-new-section items=items}}
{{/with}}
```

This pulls items from each specified component and displays them together.

## Technical Details

### Helpers

**`get-whats-new-items.js`**
- Reads `component-whats-new-*` attributes from current page
- Used automatically by component landing pages
- Returns: `{ items: [], componentName: string, hasItems: boolean }`

**`aggregate-whats-new.js`**
- Collects What's New from multiple components
- Searches each component's home page for attributes
- Used by Data Platform umbrella page
- Returns: `{ items: [], hasItems: boolean }`

Each item includes:
```javascript
{
title: string,
desc: string,
link: string, // Antora resource reference
tag: string, // Optional badge text
componentName: string,
componentColor: string, // Hex color for styling
index: number
}
```

### Partial

**`whats-new-section.hbs`**
- Reusable section template
- Supports both modes:
- Automatic (reads from current page)
- Aggregated (passed items array)

### Styling

Styles defined in `src/css/whats-new.css` (create this):
- `.whats-new-compact` - Main container
- `.whats-new-badge` - NEW badge
- `.whats-new-item` - Individual item card
- `.whats-new-tag` - Platform/tier badge

## Examples

### Cloud Component Home Page

```asciidoc
= Redpanda Cloud
:page-layout: component-home-v2

// What's New - displays automatically
:component-whats-new-1-title: Redpanda SQL
:component-whats-new-1-desc: Query streaming topics with real-time SQL analytics (BYOC only)
:component-whats-new-1-link: sql:index.adoc
:component-whats-new-1-tag: Cloud BYOC

:component-whats-new-2-title: Serverless Autoscaling
:component-whats-new-2-desc: Automatic capacity adjustments based on workload
:component-whats-new-2-link: manage:autoscaling.adoc
:component-whats-new-2-tag: Serverless
```

### Streaming Component

```asciidoc
= Redpanda Streaming
:page-layout: component-home-v3

:component-whats-new-1-title: Kubernetes Operator 2.0
:component-whats-new-1-desc: Enhanced scaling, monitoring, and Day 2 operations
:component-whats-new-1-link: deploy:kubernetes/operator.adoc

:component-whats-new-2-title: ARM64 Support
:component-whats-new-2-desc: Run Redpanda natively on ARM64 processors
:component-whats-new-2-link: deploy:arm64.adoc
```

### Data Platform Umbrella

The Data Platform page automatically shows items from all specified components:

```handlebars
{{!-- In data-platform.hbs --}}
<section class="dp-whats-new">
{{#with (aggregate-whats-new site "cloud-data-platform" "streaming" "connect")}}
{{> whats-new-section items=items}}
{{/with}}
</section>
```

This will display SQL (from cloud), Kubernetes Operator (from streaming), and any Connect features together.

## Best Practices

1. **Keep titles short** - 2-4 words max
2. **Descriptions concise** - 1-2 sentences, focus on benefit
3. **Update regularly** - Remove old items when adding new ones
4. **Use clear tags** - Platform/tier information (Cloud BYOC, Enterprise, etc.)
5. **Link to docs** - Always provide a link to full documentation
6. **Limit items** - Show 1-3 most important features, not everything

## Maintenance

To remove an item, delete its attributes. The numbering doesn't need to be contiguous:

```asciidoc
// This works fine - skipping 2
:component-whats-new-1-title: Feature A
:component-whats-new-3-title: Feature C
```

But for clarity, keep them sequential when possible.

## Troubleshooting

**Q: My What's New section isn't showing**
- Check that attributes start with `component-whats-new-` (not `page-whats-new-`)
- Verify you have at least `-title`, `-desc`, and `-link` for item 1
- Ensure the page uses a component home layout

**Q: Attributes not found on Data Platform**
- Component home page must be at root (`index.adoc`) or in `home/` module
- Attributes must be defined in the page, not in navigation config

**Q: Links broken**
- Use Antora resource syntax: `module:page.adoc`
- Links are relative to the component defining them
32 changes: 16 additions & 16 deletions context/header.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
},
"homeUrl": "/",
"components": {
"redpanda-labs": {
"labs": {
"latest": {
"title": "Labs",
"url": "/redpanda-labs/",
"url": "/labs/",
"asciidoc": {
"attributes": {
"page-header-data": {
"component-metadata": {
"order": 4
}
}
Expand All @@ -25,38 +25,39 @@
"url": "/api/"
}
},
"redpanda-cloud": {
"cloud-data-platform": {
"latest": {
"title": "Cloud",
"url": "/redpanda-cloud/home/",
"url": "/cloud-data-platform/home/",
"asciidoc": {
"attributes": {
"page-header-data": {
"order": 1 }
"component-metadata": {
"order": 1
}
}
}
}
},
"redpanda-connect": {
"connect": {
"latest": {
"title": "Connect",
"url": "/redpanda-connect/home/",
"url": "/connect/home/",
"asciidoc": {
"attributes": {
"page-header-data": {
"component-metadata": {
"order": 3
}
}
}
}
},
"ROOT": {
"streaming": {
"latest": {
"title": "Self-Managed",
"title": "Streaming",
"url": "/current/home/",
"asciidoc": {
"attributes": {
"page-header-data": {
"component-metadata": {
"order": 2
}
}
Expand All @@ -72,8 +73,8 @@
"latest": {
"asciidoc": {
"attributes": {
"page-header-data": {
"color": "#d73d23"
"component-metadata": {
"color": "#4338ca"
}
}
}
Expand All @@ -82,4 +83,3 @@
},
"uiRootPath": "/_"
}

Loading
Loading