-
Notifications
You must be signed in to change notification settings - Fork 5
Docs site restructure to support ADP and Data Platform users #173
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
JakeSCahill
wants to merge
37
commits into
main
Choose a base branch
from
feature/unified-navigation-playbooks
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
37 commits
Select commit
Hold shift + click to select a range
07eb1d9
Add unified navigation test playbook and umbrella components
JakeSCahill 8d13500
Use git reference for unified-navigation extension
JakeSCahill e6b41b9
Use git reference for unified-navigation extension testing
JakeSCahill 22ff2ee
Fix glob overflow by using remote URLs for labs and adp-docs
JakeSCahill 381965f
Upgrade Antora to 3.1.14 to fix glob overflow with local repos
JakeSCahill b8698a0
Update test playbook to use local repos for all components
JakeSCahill 481a4f7
Add version branches to test playbook for multi-version navigation
JakeSCahill 17e33f7
Fix heading case on self-managed landing page
JakeSCahill 74bbfe7
Rename Redpanda Self-Managed to Redpanda Streaming
JakeSCahill b4dbb96
Fix data platform page resource ID paths
JakeSCahill c6b6d77
Rename page-header-data to component-metadata in antora.yml files
JakeSCahill ef8e007
Update home page content and layout
JakeSCahill 6c2f536
Add quickstart link to self-managed navigation
JakeSCahill e0b44f6
Update playbooks to use v3.0.0-beta1 UI and WIP content branches
JakeSCahill c398eac
Fix extensions dependency for Netlify preview builds
JakeSCahill e68f94c
Update UI bundle to v3.0.0-beta.2
JakeSCahill 2c6df5c
Merge remote-tracking branch 'origin/main' into feature/unified-navig…
JakeSCahill 4cc86e1
Sync package-lock.json with package.json
JakeSCahill 4816b72
Trigger Netlify rebuild with latest edge function fixes
JakeSCahill cc18aca
Remove duplicate edge function config from serve-markdown.js
JakeSCahill 701ce52
Debug: Temporarily disable serve-markdown edge function
JakeSCahill eae362a
Update preview playbook to use renamed labs component branch
JakeSCahill 5dd07ad
Update UI bundle to beta.3 with CodeRabbit fixes
JakeSCahill 509255a
Add Algolia indexer to preview playbook
JakeSCahill 46bcb0b
Increase Node version and memory for build
JakeSCahill eaede9e
Update UI bundle to v3.0.0-beta.4
JakeSCahill d52ff0b
Update UI bundle to v3.0.0-beta.5
JakeSCahill a34a784
Bump bundle
JakeSCahill 9259036
Fix edge function crash: add try-catch for DOMParser WASM initialization
JakeSCahill 06f7b44
Fix home component navigation
JakeSCahill 758e9bc
Add component-metadata to home component for navigation system
JakeSCahill 0127333
Update landing pages and playbooks for interim data-platform home
JakeSCahill a4484bf
Update playbook to use remote branches and published UI bundle v3.0.0…
JakeSCahill 0260a78
Update UI bundle to v3.0.0-beta.10
JakeSCahill ecd4436
Update local playbook to use local UI bundle and rp-connect-docs
JakeSCahill b802d4a
Update preview playbook to v3.0.0-beta.10
JakeSCahill 79af60b
Fix whats_new_doc reference to resolve within version context
JakeSCahill File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| # Interim Home Page Configuration | ||
|
|
||
| **Status**: TEMPORARY - Data Platform is currently the home page instead of the dedicated home component. | ||
|
|
||
| ## Current Configuration | ||
|
|
||
| The following changes were made to use data-platform as the home page: | ||
|
|
||
| ### 1. Playbook Changes (`test-unified-nav.yml`) | ||
| ```yaml | ||
| site: | ||
| start_page: data-platform::index.adoc # Changed from home::index.adoc | ||
|
|
||
| content: | ||
| sources: | ||
| - url: . | ||
| branches: HEAD | ||
| start_paths: [data-platform, self-managed] # Removed 'home' | ||
| ``` | ||
|
|
||
| ### 2. Redirect (`netlify.toml`) | ||
| ```toml | ||
| [[redirects]] | ||
| from = "/home" | ||
| to = "/data-platform/" # Changed from "/current/home" | ||
| status = 301 | ||
| ``` | ||
|
|
||
| ## Features Added to Data Platform | ||
|
|
||
| The data-platform page now includes: | ||
|
|
||
| 1. **Ask AI Search Input** - Hero section with AI search input and suggestion chips | ||
| 2. **NEW Badge for SQL** - Cloud BYOC stat shows "+ SQL" with NEW badge when SQL docs have `page-new` attribute | ||
| 3. **Improved Hero** - More prominent call-to-action for AI assistance | ||
|
|
||
| ## How to Revert to Original Home Page | ||
|
|
||
| When ready to restore the dedicated home component, make these changes: | ||
|
|
||
| ### Step 1: Update Playbook | ||
| **File**: `test-unified-nav.yml` (or your production playbook) | ||
|
|
||
| ```yaml | ||
| site: | ||
| start_page: home::index.adoc # Change back to home | ||
|
|
||
| content: | ||
| sources: | ||
| - url: . | ||
| branches: HEAD | ||
| start_paths: [home, data-platform, self-managed] # Add 'home' back | ||
| ``` | ||
|
|
||
| ### Step 2: Restore Redirect | ||
| **File**: `netlify.toml` | ||
|
|
||
| ```toml | ||
| [[redirects]] | ||
| from = "/home" | ||
| to = "/current/home" # Change back to home | ||
| status = 301 | ||
| ``` | ||
|
|
||
| ### Step 3: Rebuild | ||
| ```bash | ||
| npx antora your-playbook.yml | ||
| ``` | ||
|
|
||
| ## Why This Change? | ||
|
|
||
| Without the Agentic Data Plane component launched, the dedicated home page felt sparse. The data-platform page provides a better entry point showcasing: | ||
| - Cloud and Self-Managed options | ||
| - Ask AI search for immediate help | ||
| - Clear path to documentation | ||
| - NEW badge highlighting Cloud BYOC SQL feature | ||
|
|
||
| ## When to Revert? | ||
|
|
||
| Revert when: | ||
| 1. Agentic Data Plane launches and needs prominent placement | ||
| 2. Home page gets redesigned with better content | ||
| 3. Marketing/product decides original structure is better |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| name: data-platform | ||
| title: Data Platform | ||
| version: ~ | ||
| start_page: index.adoc | ||
| nav: | ||
| - modules/ROOT/nav.adoc | ||
| asciidoc: | ||
| attributes: | ||
| component-metadata: | ||
| title: "Data Platform" | ||
| description: "The streaming foundation for everything you build" | ||
| color: "#4338ca" | ||
| icon: "stack-2" | ||
| # Navigation hierarchy configuration (config-driven navigation) | ||
| page-navigation: | ||
| - cloud-data-platform | ||
| - self-managed: | ||
| - streaming | ||
| - connect |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * xref:index.adoc[Overview] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,87 @@ | ||||||
| = Data Platform | ||||||
| :page-layout: data-platform | ||||||
| :!showtitle: | ||||||
| // === HERO SECTION === | ||||||
| :page-hero-eyebrow: REDPANDA DATA PLATFORM | ||||||
| :page-hero-title: pass:[The streaming foundation<br>for everything you build.] | ||||||
| :page-hero-subtitle: Run Redpanda on your infrastructure or let us manage it in the cloud. Then connect it to everything else with declarative pipelines. | ||||||
| :page-hero-stat1-number: 10x | ||||||
| :page-hero-stat1-text: faster than Kafka, same wire | ||||||
| :page-hero-stat2-number: 200+ | ||||||
| :page-hero-stat2-text: connectors | ||||||
| // === ASK AI SECTION === | ||||||
| :hero-ask-placeholder: Ask AI about Redpanda... | ||||||
| :hero-suggestions-label: Try asking: | ||||||
| :hero-suggestion-1: How do I write from Redpanda Streaming to Snowflake? | ||||||
| :hero-suggestion-2: What's the difference between Redpanda and Kafka? | ||||||
| :hero-suggestion-3: How do I create a CDC pipeline from Postgres to Redpanda Cloud? | ||||||
| // === CHOOSE SECTION (heading) === | ||||||
| :page-choose-heading: Choose how you'll run Redpanda | ||||||
| :page-choose-subtitle: Self-Managed or Cloud: same Kafka-compatible engine, different operations model. Both include Redpanda Connect for building data pipelines. | ||||||
| // === SELF-MANAGED CARD === | ||||||
| :page-selfmanaged-title: Self-Managed | ||||||
| :page-selfmanaged-tagline: Run Redpanda on your own infrastructure. | ||||||
| :page-selfmanaged-description: Bare metal, VMs, or Kubernetes. Full control over networking, storage, and upgrades: with the same single binary used in Cloud. | ||||||
| :page-selfmanaged-bullet1: Single binary, no JVM | ||||||
| :page-selfmanaged-bullet2: Air-gapped & FedRAMP-ready | ||||||
| :page-selfmanaged-bullet3: Tune every knob | ||||||
| :page-selfmanaged-stat1-label: K8s | ||||||
| :page-selfmanaged-stat1-value: Operator + Helm | ||||||
| :page-selfmanaged-cta: Open Self-Managed docs | ||||||
| // === 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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| :page-cloud-bullet1: Provisioned in 90 seconds | ||||||
| :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 | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| :page-cloud-stat2-label: BYOC | ||||||
| :page-cloud-stat2-text: Run in your VPC | ||||||
| :page-cloud-cta: Open Cloud docs | ||||||
| // === POPULAR GUIDES === | ||||||
| :page-popular-heading: Popular across Data Platform | ||||||
| :page-popular-subtitle: The guides teams open most when they're getting started. | ||||||
| :page-popular-1-title: Deploy a Redpanda cluster | ||||||
| :page-popular-1-tag: Self-Managed | ||||||
| :page-popular-2-title: Tiered storage on S3 | ||||||
| :page-popular-2-tag: Self-Managed | ||||||
| :page-popular-3-title: Create your first BYOC cluster | ||||||
| :page-popular-3-tag: Cloud | ||||||
| :page-popular-4-title: Connect Postgres CDC to Snowflake | ||||||
| :page-popular-4-tag: Connect | ||||||
| // === CORE CONCEPTS === | ||||||
| :page-concepts-heading: Core concepts | ||||||
| :page-concept-1-title: Topics & partitions | ||||||
| :page-concept-1-description: How Redpanda lays out data on disk and parallelizes reads. | ||||||
| :page-concept-2-title: Tiered storage | ||||||
| :page-concept-2-description: Offload cold segments to S3-compatible storage automatically. | ||||||
| :page-concept-3-title: Consumer groups | ||||||
| :page-concept-3-description: Coordinated, fault-tolerant consumption across many workers. | ||||||
| :page-concept-4-title: Schemas & contracts | ||||||
| :page-concept-4-description: Validate every message at the broker with Avro, Protobuf, or JSON Schema. | ||||||
| // === WHAT'S NEW SECTION === | ||||||
| :page-whats-new-1-title: Redpanda SQL | ||||||
| :page-whats-new-1-desc: Query your streaming data in real-time with SQL. Run analytical queries directly on topics without ETL (BYOC clusters only). | ||||||
| :page-whats-new-1-link: cloud-data-platform:sql:index.adoc | ||||||
| :page-whats-new-1-tag: Cloud BYOC | ||||||
| // === HELP FOOTER === | ||||||
| :page-help-heading: Need help choosing? | ||||||
| :page-help-subtitle: Our team can walk you through the options and help you get started. | ||||||
| :page-help-btn1-text: Talk to sales | ||||||
| :page-help-btn1-url: https://redpanda.com/contact | ||||||
| :page-help-btn2-text: Join Slack | ||||||
| :page-help-btn2-url: https://redpanda.com/slack | ||||||
| // Self-Managed links | ||||||
| :page-self-managed-home: streaming:home:index.adoc | ||||||
| :page-self-managed-quickstart: streaming:get-started:quick-start.adoc | ||||||
| :page-self-managed-tiered-storage: streaming:manage:tiered-storage.adoc | ||||||
| :page-self-managed-producers: streaming:develop:produce-data/configure-producers.adoc | ||||||
| :page-self-managed-consumers: streaming:develop:consume-data/consumer-offsets.adoc | ||||||
| // Cloud links | ||||||
| :page-cloud-home: cloud-data-platform:home:index.adoc | ||||||
| :page-cloud-byoc: cloud-data-platform:get-started:cluster-types/byoc/index.adoc | ||||||
| :page-cloud-sql-docs: cloud-data-platform:sql:index.adoc | ||||||
| // Connect links | ||||||
| :page-connect-quickstart: connect:get-started:quickstarts/index.adoc | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| * xref:index.adoc[Overview] | ||
| * xref:mcp-setup.adoc[Install the Docs MCP Server] |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is about RPCN