Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
5539f42
Rename ROOT component to streaming and add unified navigation metadata
JakeSCahill May 12, 2026
1341559
Update all component xrefs for unified navigation
JakeSCahill May 12, 2026
a4766bf
Fix xref errors: labs component uses ROOT module, not streaming
JakeSCahill May 12, 2026
ac08227
Rename Redpanda Self-Managed to Redpanda Streaming
JakeSCahill May 12, 2026
226c388
Add cloud-product-name attribute for single-sourced content
JakeSCahill May 12, 2026
7592bb5
Remove local product-name attributes (now in shared branch)
JakeSCahill May 12, 2026
3f3da8c
Rename page-header-data to component-metadata and remove section field
JakeSCahill May 14, 2026
987d219
Update streaming component home page to v3 layout
JakeSCahill May 15, 2026
8405d27
Fix broken Labs xrefs on home page
JakeSCahill May 18, 2026
0a955f4
Fix xrefs for single-sourcing in schema-reg-contexts
JakeSCahill May 18, 2026
4cfe668
Change title from Self-Managed to Streaming
JakeSCahill May 18, 2026
b1a5adb
Remove duplicate page-role attribute from streaming home page
JakeSCahill May 20, 2026
9db51a5
Add component-specific AI suggestions for chat drawer
JakeSCahill May 20, 2026
055d461
Add version selector footer link attributes for 26.1/main with .adoc …
JakeSCahill May 21, 2026
c07dae7
Merge origin/main into feature/rename-streaming-main
JakeSCahill May 22, 2026
d6108fc
Enable parent context navigation cards
JakeSCahill May 22, 2026
de59203
Remove unused page-use-parent-context flag
JakeSCahill May 22, 2026
fee6dcd
Replace {product-name} with Redpanda Streaming
JakeSCahill May 25, 2026
464ea4b
Update component color to match design system
JakeSCahill May 26, 2026
88444ad
Fix unescaped {id} attributes in schema-reg-authorization.adoc
JakeSCahill May 26, 2026
30fabc1
Fix remaining unescaped attributes in schema-reg and release notes
JakeSCahill May 26, 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
2 changes: 1 addition & 1 deletion .github/workflows/test-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:
create_issue_on_fail: true
token: ${{ env.ACTIONS_BOT_TOKEN }}

- name: Test Redpanda Self-Managed quickstart
- name: Test Redpanda Streaming quickstart
if: ${{ needs.setup.outputs.quickstart == 'true' || needs.setup.outputs.console == 'true' }}
uses: doc-detective/github-action@v1
with:
Expand Down
4 changes: 2 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ image:https://img.shields.io/coderabbit/prs/github/redpanda-data/docs?utm_source
</p></a>
++++

This repository hosts the documentation content for Redpanda Self-Managed.
This repository hosts the documentation content for Redpanda Streaming.

== Contribute

Expand Down Expand Up @@ -94,7 +94,7 @@ npm run serve

== Versioning

Versioned content is stored in branches that track the version of Redpanda Self-Managed. Production branches use the *v/x.y* naming pattern. For example, branch `v/22.3` hosts the content for version 22.3.x of Redpanda Self-Managed. The `main` branch always contains docs for the latest release.
Versioned content is stored in branches that track the version of Redpanda Streaming. Production branches use the *v/x.y* naming pattern. For example, branch `v/22.3` hosts the content for version 22.3.x of Redpanda Streaming. The `main` branch always contains docs for the latest release.

The production {url-playbook}[docs site playbook] instructs Antora to automatically aggregate content in the following branches:

Expand Down
82 changes: 82 additions & 0 deletions add-parent-context-flag.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
#!/bin/bash

# Script to add page-use-parent-context flag to all Streaming version branches
# Usage: ./add-parent-context-flag.sh

set -e

# Define all branches to update
BRANCHES=(
"feature/rename-streaming-main"
"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"
)

echo "🚀 Starting to add page-use-parent-context flag to all Streaming branches..."
echo ""

for BRANCH in "${BRANCHES[@]}"; do
echo "═══════════════════════════════════════════════════════════════"
echo "📝 Processing branch: $BRANCH"
echo "═══════════════════════════════════════════════════════════════"

# Checkout the branch
git checkout "$BRANCH"

# Check if the flag already exists
if grep -q "page-use-parent-context: true" antora.yml; then
echo "✅ Flag already exists in $BRANCH, skipping..."
echo ""
continue
fi

# Add the flag after "attributes:" line
# Using sed to insert the line
sed -i '' '/^ attributes:$/a\
page-use-parent-context: true
' antora.yml

# Verify the change was made
if grep -q "page-use-parent-context: true" antora.yml; then
echo "✅ Successfully added flag to antora.yml"

# Show the change
echo "📄 Changes:"
git diff antora.yml | head -15

# Commit the change
git add antora.yml
git commit -m "Enable parent context navigation cards

Add page-use-parent-context flag to enable hierarchical navigation
with parent context cards in the UI. This shows the Self-Managed
parent card with Streaming/Connect subcards when viewing Streaming pages.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>"

echo "✅ Committed changes to $BRANCH"
echo ""
else
echo "❌ Failed to add flag to $BRANCH"
echo ""
exit 1
fi
done

echo "═══════════════════════════════════════════════════════════════"
echo "✅ All branches updated successfully!"
echo "═══════════════════════════════════════════════════════════════"
echo ""
echo "📤 Ready to push. Run the following commands to push all branches:"
echo ""
for BRANCH in "${BRANCHES[@]}"; do
echo "git push origin $BRANCH"
done
echo ""
echo "Or push all at once with:"
echo "git push origin $(echo ${BRANCHES[@]})"
34 changes: 24 additions & 10 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,31 @@
name: ROOT
title: Self-Managed
name: streaming
title: Streaming
version: 26.1
start_page: home:index.adoc
nav:
- modules/ROOT/nav.adoc
asciidoc:
attributes:
# AI suggestions for the chat drawer
ai-suggestion-1: How do I configure a Redpanda cluster?
ai-suggestion-2: What are best practices for Kafka migration?
ai-suggestion-3: How do I set up Tiered Storage?
ai-suggestion-4: Troubleshoot broker connectivity issues
# Version selector footer links (used by compute-end-of-life extension)
# page-whats-new-doc: Antora resource ID for the "What's new" link in version dropdown footer
# page-upgrade-doc: Antora resource ID for the "Upgrade guide" link in version dropdown footer
page-whats-new-doc: get-started:release-notes/index.adoc
page-upgrade-doc: upgrade:index.adoc
# Date of release in the format YYYY-MM-DD
page-release-date: 2026-03-31
# Only used in the main branch (latest version)
page-header-data:
component-metadata:
title: "Streaming"
parent-component: "self-managed"
description: "Redpanda broker and rpk CLI for self-managed deployments."
color: "#4D7C0F"
order: 2
color: '#107569'
icon: "activity"
# Name of the Redpanda UI used in single-sourced content with Redpanda Cloud.
ui: Redpanda Console@
# Fallback versions
Expand Down Expand Up @@ -81,7 +95,7 @@ asciidoc:
- page: develop/guide-nodejs/
reason: Page moved to Redpanda Labs.
# Data for the home page
page-home-intro: Redpanda is a Kafka-compatible event streaming platform built for data-intensive applications. Install Self-Managed Redpanda in your environment with the free Community Edition or with the Enterprise Edition for additional features like Tiered Storage, Continuous Data Balancing, and Audit Logging.
page-home-intro: Redpanda is a Kafka-compatible event streaming platform built for data-intensive applications. Install Redpanda Streaming in your environment with the free Community Edition or with the Enterprise Edition for additional features like Tiered Storage, Continuous Data Balancing, and Audit Logging.
#page-home-image:
page-home-intro-learn-more: get-started:intro-to-events.adoc
page-home-primary-row-title: Deploy
Expand Down Expand Up @@ -113,16 +127,16 @@ asciidoc:
url: 'manage:monitoring.adoc'
link-text: 'Learn more'
- title: 'rpk commands'
description: 'Redpanda CLI reference for Self-Managed Redpanda.'
description: 'Redpanda CLI reference for Redpanda Streaming.'
url: 'reference:rpk/index.adoc'
link-text: 'Learn more'
page-home-tertiary-row-title: 'Labs'
page-home-tertiary-row:
- title: 'Set up Postgres CDC with Debezium and Redpanda'
url: 'redpanda-labs:docker-compose:cdc-postgres-json.adoc'
url: 'labs:docker-compose:cdc-postgres-json.adoc'
- title: 'Redact information in JSON messages'
url: 'redpanda-labs:data-transforms:redaction-go.adoc'
url: 'labs:data-transforms:redaction-go.adoc'
- title: 'Stream text embeddings with Redpanda, OpenAI, and MongoDB'
url: 'redpanda-labs:redpanda-connect:openai.adoc'
url: 'labs:connect-plugins:openai.adoc'
- title: 'Build a chat room application with Redpanda and Rust'
url: 'redpanda-labs:clients:docker-rust.adoc'
url: 'labs:clients:docker-rust.adoc'
6 changes: 3 additions & 3 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
** xref:console:index.adoc[Introduction to Redpanda Console]
** xref:get-started:install-beta.adoc[Install Beta]
** xref:get-started:quickstarts.adoc[Quickstarts]
*** xref:get-started:quick-start.adoc[Redpanda Self-Managed]
*** xref:get-started:quick-start.adoc[Redpanda Streaming]
*** xref:get-started:rpk-quickstart.adoc[]
*** xref:get-started:docker-compose-labs.adoc[Docker Compose Labs]
** xref:get-started:licensing/index.adoc[Redpanda Licensing]
Expand Down Expand Up @@ -98,7 +98,7 @@
*** xref:deploy:console/linux/index.adoc[Linux]
**** xref:deploy:console/linux/requirements.adoc[Requirements]
**** xref:deploy:console/linux/deploy.adoc[Deploy on Linux]
** xref:redpanda-connect:home:index.adoc[Redpanda Connect]
** xref:connect:home:index.adoc[Redpanda Connect]
** xref:deploy:kafka-connect/index.adoc[Kafka Connect]
*** xref:deploy:kafka-connect/k-deploy-kafka-connect.adoc[Deploy on Kubernetes]
*** xref:deploy:kafka-connect/deploy-kafka-connect.adoc[Deploy on Docker]
Expand Down Expand Up @@ -303,7 +303,7 @@
**** xref:reference:k-operator-helm-spec.adoc[Redpanda Operator]
**** xref:reference:k-console-helm-spec.adoc[Redpanda Console]
**** xref:reference:k-connector-helm-spec.adoc[Kafka Connect]
**** xref:redpanda-connect:reference:k-connect-helm-spec.adoc[Redpanda Connect]
**** xref:connect:reference:k-connect-helm-spec.adoc[Redpanda Connect]
*** xref:reference:k-crd-index.adoc[]
**** xref:reference:k-crd.adoc[]
** xref:reference:monitor-metrics.adoc[Monitoring Metrics]
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/configure-console.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Configure Redpanda Console
:description: Learn how to configure Redpanda Console using environment variables, YAML files, or command-line arguments.
:page-aliases: console:reference/config.adoc, reference:console/config.adoc
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/configure-console.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/configure-console.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]


Redpanda Console loads configuration properties from three sources, in the following order of precedence:
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/connect-to-redpanda.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Configure Redpanda Console to Connect to a Redpanda Cluster
:description: Learn how to configure Redpanda Console to connect to a Redpanda cluster and ensure communication with your Redpanda brokers.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/connect-to-redpanda.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/connect-to-redpanda.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]


Redpanda Console connects to your Redpanda cluster using dedicated configuration blocks for the Kafka API, Schema Registry API, and Admin API. Each connection serves a different purpose:
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/deserialization.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Configure Message Deserialization in Redpanda Console
:description: Learn how to configure Redpanda Console to use Schema Registry, Protobuf files, and other deserialization methods to ensure your data is correctly interpreted and displayed.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/deserialization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/deserialization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]


Redpanda Console provides tools for deserializing and inspecting messages in Kafka topics. This topic explains how to configure Redpanda Console to use Schema Registry, Protobuf files, and other deserialization methods to ensure your data is correctly interpreted and displayed.
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/enterprise-license.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Add a License Key to Redpanda Console
:description: Learn how to apply or update a license key to Redpanda Console.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/enterprise-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/enterprise-license.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]


To enable xref:get-started:licensing/overview.adoc#console[enterprise features for Redpanda Console], you must have an Enterprise Edition license to load at startup. This guide explains how to configure Redpanda Console to load the license key from its local configuration.
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/http-path-rewrites.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= HTTP Path Rewrites in Redpanda Console
:description: Learn how to configure Redpanda Console to work with your URL path rewrites, particularly when hosted under a subpath.
:page-aliases: console:features/http-path-rewrites.adoc, manage:console/http-path-rewrites.adoc
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/http-path-rewrites.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/http-path-rewrites.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]


If you want to host Redpanda Console under a subpath rather than the root path, you need to configure HTTP path rewrites. This allows you to serve Redpanda Console under a subpath of your domain, such as `+https://my-company.com/redpanda/console+`, instead of directly from `+https://my-company.com+`. This type of configuration is often necessary when:
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/kafka-connect.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Connect Redpanda Console to Kafka Connect Clusters
:description: Learn how to connect one or more Kafka Connect clusters with Redpanda Console.
:page-aliases: console:features/kafka-connect.adoc, manage:console/kafka-connect.adoc
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/kafka-connect.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/kafka-connect.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::shared:partial$community-supported-kc.adoc[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Learn how authentication in Redpanda Console enables users to log in and optionally forward their credentials to the connected Redpanda cluster, ensuring all API requests are executed under the user's identity.
:page-aliases: console:single-sign-on/authentication.adoc, manage:security/console/authentication.adoc, console:config/security/plain.adoc, console:config/security/okta.adoc, console:config/security/generic-oidc.adoc, console:config/security/keycloak.adoc, console:config/security/github.adoc, console:config/security/google.adoc, console:config/security/azure-ad.adoc
:page-categories: Security, Management, Redpanda Console
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authentication.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/security/authentication.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]



Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/security/authorization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: Learn how to configure role-based access control (RBAC) in Redpanda Console to restrict system access to authorized users.
:page-aliases: console:single-sign-on/authorization.adoc, manage:security/console/authorization.adoc, console:features/role-bindings.adoc, console:reference/role-bindings.adoc, reference:console/role-bindings.adoc
:page-categories: Security, Management, Redpanda Console
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authorization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/security/authorization.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]


[NOTE]
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/security/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
:page-aliases: manage:security/console/index.adoc
:description: Learn about security topics for Redpanda Console.
:page-layout: index
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/security/index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
:description: Learn how to secure Redpanda Console using TLS, either by letting Redpanda Console handle TLS termination or by offloading it to an upstream component, such as a reverse proxy or a Cloud HTTPS LoadBalancer.
:page-categories: Management, Security, Redpanda Console
:page-exclude-related-labs: true
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/tls-termination.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/security/tls-termination.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]


To secure Redpanda Console using TLS (Transport Layer Security), you can either let Redpanda Console handle TLS termination or you can offload it to an upstream component, such as a reverse proxy or a cloud HTTPS load balancer. TLS termination refers to the process of decrypting incoming TLS-encrypted traffic. Choosing the right approach depends on various factors, such as your application's traffic load, the complexity of your infrastructure, security requirements, and resource availability:
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/config/topic-documentation.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Enable Topic Documentation in Redpanda Console
:description: Learn how to embed your Kafka topic documentation into the Redpanda Console UI by linking a Git repository that contains the topic documentation files.
:page-aliases: console:features/topic-documentation.adoc, manage:console/topic-documentation.adoc
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/topic-documentation.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:config/topic-documentation.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]


You can embed topic documentation into the Redpanda Console user interface by providing access to a public or private Git repository that hosts the documentation files in Markdown format.
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Introduction to Redpanda Console
:description: Learn about Redpanda Console: a web interface for managing and interacting with Redpanda clusters.
:page-aliases: console:index/index.adoc, console:features/index.adoc, reference:console/index.adoc
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@streaming:console:index.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]


Redpanda Console is a web interface for managing and interacting with Redpanda clusters. Built to provide a seamless experience for developers working with streaming data, Redpanda Console simplifies tasks associated with managing data streams, offering a UI that helps you monitor, troubleshoot, and optimize your streaming workloads.
Expand Down
Loading