Docs site restructure to support ADP and Data Platform users#173
Docs site restructure to support ADP and Data Platform users#173JakeSCahill wants to merge 44 commits into
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
|
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>
|
https://deploy-preview-173--redpanda-documentation.netlify.app/data-platform/ |
|
https://deploy-preview-173--redpanda-documentation.netlify.app/connect/get-started/quickstarts/ |
|
Why @micheleRP? |
because they look and feel different |
that's an icon. It's meant to represent a terminal prompt. |
Added ai-suggestion-1 through ai-suggestion-4 attributes to data-platform and self-managed components to provide context-aware AI chat suggestions instead of generic defaults. - data-platform: Questions about Snowflake, Kafka differences, CDC pipelines - self-managed: Questions about Kubernetes, Tiered Storage, configuration Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Review
Critical
-
antora-playbook.yml:92-94— production pointsredpanda-labsatbranches: main, butmainstill hasname: redpanda-labs. This PR's extensions (generate-index-data:369,replace-attributes-in-attachments:411) andmeta-docs/CONTRIBUTING.adocusecomponent: labs. Build will not find alabscomponent. Local + preview playbooks already usefeature/page-header-data(which hasname: labs); production needs the same swap or the rename has to land onredpanda-labs/mainfirst. -
package.json:20—"@redpanda-data/docs-extensions-and-macros": "github:...#feature/unified-navigation". Pinning to a feature branch means a force-push will break prod. Must swap to a tagged release before the relaunch. -
home/modules/ROOT/pages/index.adoc:42— broken xref::page-cloud-docs: cloud-data-platform:ROOT:index.adoc. Onfeature/component-home-v3the start page ishome:index.adoc(verified —ROOT/pages/index.adocreturns 404). Fix to:cloud-data-platform:home:index.adoc. (Line 48'sagentic-data-plane:ROOT:index.adocis fine — that component's start page isROOT:index.adoc.) -
self-managed/modules/ROOT/pages/index.adoc:20,24— broken xrefs:streaming:deploy:deployment-option/self-hosted/kubernetes/index.adocstreaming:deploy:deployment-option/self-hosted/manual/index.adoc
On
feature/rename-streaming-main, the actual paths aredeploy:redpanda/kubernetes/index.adocanddeploy:redpanda/manual/index.adoc(verified via GitHub API; nopage-aliaseson the kubernetes index covers the old path). -
self-managed/modules/ROOT/pages/index.adoc:5— em dash violation in:page-hero-description:(infrastructure—whether on bare metal...). Strip per Redpanda style. Suggested: replace with comma. -
INTERIM-HOME-PAGE.mdships in the PR root with content like "TEMPORARY", "Why this change?", "When to revert?". Internal handoff note — should not live at repo root in a public docs site repo. Delete or move tometa-docs/with a clear WIP prefix. Also contradictsantora-playbook.yml:3(start_page: home:ROOT:index.adoc) — onlytest-unified-nav.ymlusesdata-platform::index.adoc. -
test-unified-nav.ymlships with hardcoded/Users/jakecahill/Documents/...paths (lines 22, 42, 46, 50, 55, 60). Personal dev playbook; delete before merge. -
local-antora-playbook.yml:47, 55— hardcoded/Users/jakecahill/Documents/rp-connect-docsand/Users/jakecahill/Documents/docs-ui/build/ui-bundle.zip. Other contributors can't use this. Replace with the GitHub URLs the preview playbook uses.
Suggestions
netlify/edge-functions/skill-search-docs.ts:23— still points tohttps://docs.redpanda.com/current/home/; should be/streaming/home/(the file already migrated the cloud/connect/labs sections).home/modules/ROOT/pages/llms.adoc— mixed migration: paths like/current/get-started/quickstarts.md,/current/deploy.md,/current/reference/rpk/...,/current/console.md,/current/troubleshoot.md(lines 35, 49, 57–58, 62, 70, 75–76, 90–93, 97–98, 103) still referencecurrentwhile sibling sections moved tocloud-data-platform,connect,labs. Finish the rename or file a follow-up.netlify.toml:16— Lighthouse plugin auditscurrent/home/index.html; will 404 after rename.netlify.toml:62-80— markdown URL aliases still use/redpanda-cloud.md,/redpanda-connect.md,/redpanda-labs.md. Add new aliases (/cloud-data-platform.md,/connect.md,/labs.md) and keep the old ones as redirects.netlify.toml:112-114—/home → /data-platform/301 looks like the INTERIM behavior. Confirm whetherhomeis actually the production home.netlify.toml:354-501— every bulk redirect target still writes to/redpanda-cloud/,/redpanda-connect/,/redpanda-labs/. After the rename those targets 404. Probably deferrable to a follow-up PR, but flag it.
Coordination risk
Verified all referenced feature branches exist and component names match the playbook references:
docs/feature/rename-streaming-main→name: streaming✓cloud-docs/feature/component-home-v3→name: cloud-data-platform✓ (butstart_page: home:index.adoc, notROOT:index.adoc— see Critical #3)rp-connect-docs/feature/unified-navigation→name: connect✓adp-docs/feature/platform-badges→name: agentic-data-plane✓redpanda-labs/main→ stillname: redpanda-labs✗ (see Critical #1)- All 7
feature/rename-streaming-23.3 … 25.3branches exist - UI bundle
v3.0.0-beta.10exists
Nothing pins to a released version — every source is on a moving feature branch. Acceptable while staging the relaunch, but the 14 PRs must merge in lockstep, and package.json:20 plus the redpanda-labs branch ref need to be the last things switched.
Cross-rollout notes (applies to all 14 PRs in the docs.redpanda.com relaunch)
Posting these here rather than fragmenting across all 14 PRs.
Suggested approval / merge order
The 14 PRs must merge in a tight window, but within that window order matters because component renames invalidate xref targets.
- First (independent, ready):
docsredpanda-data/docs#1698-redpanda-data/docs#1704 — version-branch renames. No new content beyondantora.ymlrewrites and xref sweeps. - Then (small fixes):
docs-extensions-and-macrosredpanda-data/docs-extensions-and-macros#197, after applying the 2 critical fixes. - Then (with verifications):
docsredpanda-data/docs#1705,cloud-docsredpanda-data/cloud-docs#578,rp-connect-docsredpanda-data/rp-connect-docs#427 — after the fix-and-confirm cycles. - Then (after coordination fixes):
redpanda-labsredpanda-data/redpanda-labs#285 — after thepage-header-data→component-metadatarename and removal of the unfinishedkubernetes/stretch-clusterlab. - Then:
docs-site#173 — after the critical fixes above (especially thepackage.jsonunpin and theredpanda-labsbranch reference). - Last:
docs-uiredpanda-data/docs-ui#376 — after the major rework pass. UI bundle should pin to a tagged release (v3.0.0-beta.10or later), and the hardcoded component names should either have fallbacks or be the final hard switch.
Verification (cheap end-to-end checks before / during merge)
-
{product-name}resolution (referenced bydocsredpanda-data/docs#1705 and redpanda-data/docs#1698):cd /Users/miche/projects/docs && git checkout feature/rename-streaming-main && npm run buildIf
{product-name}renders as literal{product-name}, the production playbook needs to aggregatesharedintostreaming. -
Cloud landing page schema (cloud-docs redpanda-data/cloud-docs#578): open the Netlify deploy preview. Confirm the
Choose your componentandChoose your deploymentblocks render (they should, per thecomponent-home-v3partial which supports:page-component-N-*:and:page-deployment-N-*:attrs). -
docs-uiredpanda-data/docs-ui#376 CSS lint —cd /Users/miche/projects/docs-ui && gulp bundle. If lint fails on the keyframes /color-mix(in sRGB,...)etc., Critical #2 is real. -
docs-uiredpanda-data/docs-ui#376 empty-dropdown bug — local preview with a component atdefaultversion and >1 version available. If the chevron renders but the menu has no items, Critical #4 is real.
Cross-PR coordination items (separate bucket from per-PR critical)
These don't break any single PR on its own merits, but they will break the coordinated cutover if not aligned before the merge window:
-
Attribute key inconsistency. Every renamed component sets new metadata in its
antora.yml, but the attribute key differs:component-metadata—docsredpanda-data/docs#1698-redpanda-data/docs#1705,rp-connect-docsredpanda-data/rp-connect-docs#427,cloud-docsredpanda-data/cloud-docs#578page-header-data—redpanda-labsredpanda-data/redpanda-labs#285 (outlier)
The
docs-uiv3 helpers readcomponent-metadata. If the labs PR ships as-is, labs likely falls out of the sidebar or renders with stale metadata. Pickcomponent-metadataand update labs to match. -
redpanda-labsrename branch ordering. This playbook pointsredpanda-labsatbranches: main, butmainstill hasname: redpanda-labs. The new extensions andmeta-docs/CONTRIBUTING.adocalready usecomponent: labs. The labs PR must either merge intomainfirst, OR this playbook must point at the feature branch. -
docs-uiredpanda-data/docs-ui#376 hardcoded component names with no fallback. Despite the PR body's "fallback logic" claim, several helpers/partials flip to the new name with no||fallback. Either restore real fallbacks, or commit to merging the rename PRs strictly before the UI bundle deploys. -
{product-name}attribute is used heavily indocsredpanda-data/docs#1705 + redpanda-data/docs#1698 but is defined only on the docssharedbranch (Redpanda Streaming). Confirm the production playbook still aggregatessharedinto the renamedstreamingcomponent, or every{product-name}will render as literal. -
Feature-branch pinning in
package.json:20. Extensions pinned togithub:...#feature/unified-navigation. A force-push on that branch breaks production. Swap to a tagged release before merging. -
Stale
local-antora-playbook.ymlstart_page:in two repos.rp-connect-docs:start_page: redpanda-connect:home:index.adoc(component is nowconnect)redpanda-labs:start_page: redpanda-labs:ROOT:index.adoc(component is nowlabs)
Local dev builds will fail on both until fixed.
-
PR redpanda-data/docs#1697 ("Add page-header-data for unified navigation") is closed, never merged (closed 2026-05-12). Its work has been folded into redpanda-data/docs#1705. Multiple sibling PRs still reference redpanda-data/docs#1697 in their bodies — Jake can either delete those references or note "superseded by redpanda-data/docs#1705."
Michele's existing inline comments on this PR
All 5 of her suggested edits already appear to be applied in the current PR head:
:page-deploy-2-desc:inself-managed/.../index.adoc:13matches her wording:page-hero-stat2-number: 300+indata-platform/.../index.adoc:10matches300+ connectors for sources and destinationsinskill-search-docs.ts:42matches:page-cloud-description: ... Serverless, Dedicated, or Bring Your Own Cloud (BYOC).indata-platform/.../index.adoc:34matches:page-cloud-stat1-text: SLA on BYOC & Dedicatedindata-platform/.../index.adoc:39matches
Safe to resolve all 5 on GitHub.
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.







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: