Skip to content

Docs site restructure to support ADP and Data Platform users#173

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

Docs site restructure to support ADP and Data Platform users#173
JakeSCahill wants to merge 37 commits into
mainfrom
feature/unified-navigation-playbooks

Conversation

@JakeSCahill
Copy link
Copy Markdown
Contributor

@JakeSCahill JakeSCahill commented May 12, 2026

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:

  • ✅ 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 79af60b
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-documentation/deploys/6a0dd2d41a8127000865f1a7
😎 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.

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 22 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>
- 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>
@micheleRP
Copy link
Copy Markdown
Contributor

For the Cloud home page, suggest removing second line in the page text at the top. The page has "Deploy Serverless clusters in seconds", "Start in seconds", and "Start streaming instantly," which feels like 1 too many.

@micheleRP
Copy link
Copy Markdown
Contributor

There's a little jump when you navigate through the side navs.

@micheleRP
Copy link
Copy Markdown
Contributor

I think I'd like to remove all text from this dropdown. I don't think it adds anything
image

// === 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
: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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:page-cloud-stat1-text: SLA on Dedicated
:page-cloud-stat1-text: SLA on BYOC & Dedicated

@micheleRP
Copy link
Copy Markdown
Contributor

I started to add suggestions to this card, but I think we should probably just rework it altogether, since it conflates Serverless, Dedicated, and BYOC
image

@micheleRP
Copy link
Copy Markdown
Contributor

Can you shape these buttons more similarly?
image

@micheleRP
Copy link
Copy Markdown
Contributor

The bottom row of buttons here aren't linking (Connect Postgres, Migrate, SR)
image

@micheleRP
Copy link
Copy Markdown
Contributor

I think we should consider removing the Core concepts section from the Data Platform home page, since they could have different content for SM and Cloud
image

@micheleRP
Copy link
Copy Markdown
Contributor

footer/copyright missing

@kbatuigas
Copy link
Copy Markdown
Contributor

This NEW card for SQL has the green Self-Managed color wrap. The NEW in green also gives Self-Managed. Suggest using the Data Platform purple for both NEW button and card wrap. image

Also: what do you think about adding cards under this What's new to both the Cloud & the SM What's New pages?

To add - how does the What's New card on the landing pages get populated? And how many items? I'm assuming that the SM home/landing page doesn't have one because we just didn't pick one?

I also noticed that the card has a slightly different placement on the Data Platform home vs Cloud home. (Maybe it's my window size?) In Cloud, it has more padding around it and is closer to the BYOC/Serverless options, and in Data Platform it's flush all the way to the upper right boundary. But either way the What's new card feels a bit disjointed and out of place from the rest of the elements on the landing page

@micheleRP
Copy link
Copy Markdown
Contributor

The back button is not working from Labs

@micheleRP
Copy link
Copy Markdown
Contributor

Some comments about these Cloud links:
We need to remove this altogether (I'll add a Jira): https://docs.redpanda.com/redpanda-labs/ai-agents/langchain-agent/
I think links should go directly onto a doc page and not an index page
image

@Feediver1
Copy link
Copy Markdown
Contributor

Spacing on this page seems off/inconsistent:

  • The amount of space after WHAT ARE YOU HERE FOR and OR JUMP STRAIGHT TO A PRODUCT seems inconsistent--shouldn't they have the same amount of space between text and next box below?
  • Not sure if just my browser setting or what, but the font seems very small. What is the default size? Font in black box at the top of the page renders much larger than anything that comes after it on this page.
image

Why so much empty space here?
image

@Feediver1
Copy link
Copy Markdown
Contributor

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)?

@Feediver1
Copy link
Copy Markdown
Contributor

Overall, there is a great deal of empty/white space on https://deploy-preview-173--redpanda-documentation.netlify.app/home/.
It does not look like the last prototype we saw.

@Feediver1
Copy link
Copy Markdown
Contributor

Feediver1 commented May 20, 2026

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/agentic-data-plane/get-started/invite-team/
image

@Feediver1
Copy link
Copy Markdown
Contributor

The spacing of the text under Choose how you'll run Redpanda, and Cloud and Self-Managed seems different. Or perhaps it is that the font size on top is larger than in the tiles. Given all the real estate here, not sure I understand why we go down a font size in the tiles. And the text above the tiles looks more squished together than the text in the tiles.
image

@Feediver1
Copy link
Copy Markdown
Contributor

Not sure I understand the convention wrt to spacing here--seems inconsistent.
image

@micheleRP
Copy link
Copy Markdown
Contributor

Similar to many of Joyce's comments above, there's extra padding now when you resize your screen wide:
image

@micheleRP
Copy link
Copy Markdown
Contributor

so minor, but there's an extra white space before period in the Make a contribution popup (after ... read our contribution guide)
image

@Feediver1
Copy link
Copy Markdown
Contributor

https://deploy-preview-173--redpanda-documentation.netlify.app/cloud-data-platform/home/
I'm troubled by the layout/spacing on this page.

  • Not sure which deployment to pick? << Shouldn't the text size here be a few sizes larger? There is so much space above it, and then the text is pushed down close too the tiles. Just looks off balance.
  • The What's new tile: why is it up higher than the other two here?
    Below the fold on this page:
  • Could we have color in some of the tiles? Everything is black and white and nothing in particular stands out. Or maybe a different font color for the headings? Just thinking out loud.
    https://deploy-preview-173--redpanda-documentation.netlify.app/cloud-data-platform/sql/
  • Nowhere on this Redpanda SQL landing page does it say what Redpanda SQL is. Will this be corrected after all the RP SQL PRs are merged @kbatuigas ?
  • For PREV here, it's unclear where/why we have Work with Jira Issues. I understand it is the last section in Connect, but it seems odd that anyone would click this to go from RP SQL to this topic. Maybe have it go to Redpanda Connect?
    https://deploy-preview-173--redpanda-documentation.netlify.app/cloud-data-platform/develop/connect/cookbooks/jira/#see-also
  • Why have we changed from Next steps or Suggested reading to See also? Looks odd at the bottom in the right sidenav too.
  • Why are the heading links in the right sidenav so much smaller now? Compared to existing pages and they are definitely smaller.

@Feediver1
Copy link
Copy Markdown
Contributor

Feediver1 commented May 20, 2026

image
  • In each of these tiles, can't we just make the Cloud and Self-Managed headings the links? That way, you don't need the separate Open Cloud docs and Open Self-Managed docs lines below.

https://deploy-preview-173--redpanda-documentation.netlify.app/data-platform/#

  • Same comment as on the cloud landing page: spacing before the bottom fold seems excessive. What are the tiles in Popular across Data Platform based on? Also, the tile with Tiered storage on S3 should read Tiered Storage. Not sure why S3 is here, as the TS doc also has Google Cloud Storage and MS.
  • Also, we spell out Kubernetes, but then use K8s below in the same tile. I think we should spell it out in both places.

@Feediver1
Copy link
Copy Markdown
Contributor

image

Troubled by all of the underlined content here.

  • If you click on Released, or Until, or on a date, or LATEST, they all take you to the same place. We don't need all the underlining here. I think it muddies things here. I don't think the numbers on the right are helpful either,
  • Also, there are tabs here: All, Latest, Supported, EOL. I'd expect to be taken to the Latest tab if I click the LATEST link, or the Supported tab if I click SUPPORTED. As I said above--they all take you to the same place, so please remove the underline from any superfluous links here.
  • If a user clicks the Support Policy link, they are taken to https://support.redpanda.com/hc/en-us/articles/20617574366743-Redpanda-Supported-Versions, in a new tab completely out of the documentation context. The destination page here has the Ask AI widget in the middle, which is odd given that it is top right in our doc pages.

@Feediver1
Copy link
Copy Markdown
Contributor

Feediver1 commented May 20, 2026

https://deploy-preview-173--redpanda-documentation.netlify.app/data-platform/
I don't think the tile with Connect Postgres CDC to Snowflake is linking to the correct page. Instead of taking users to https://deploy-preview-173--redpanda-documentation.netlify.app/connect/get-started/quickstarts/, shouldn't it go to https://deploy-preview-173--redpanda-documentation.netlify.app/connect/components/inputs/postgres_cdc/ or some Iceberg page? Also, I believe it is PostgreSQL not Postgres, no?

@Feediver1
Copy link
Copy Markdown
Contributor

https://deploy-preview-173--redpanda-documentation.netlify.app/connect/get-started/quickstarts/
I see a dash before the Bloblang Playground heading on right sidenav under Connect Tools. Why? Is this a typo?
image

@Feediver1
Copy link
Copy Markdown
Contributor

Feediver1 commented May 20, 2026

Can you shape these buttons more similarly? image

Why @micheleRP?

@Feediver1
Copy link
Copy Markdown
Contributor

I think I'd like to remove all text from this dropdown. I don't think it adds anything image

Not sure I agree. Remember that our new org model might not make sense to people who have been using our docs all along. The new Streaming category comes to mind--this little text may help them.

@micheleRP
Copy link
Copy Markdown
Contributor

Can you shape these buttons more similarly? image

Why @micheleRP?

because they look and feel different

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.

4 participants