Rename ROOT component to streaming (v24.2)

README.adoc

@@ -14,7 +14,7 @@ image:https://api.netlify.com/api/v1/badges/5b89dd6f-1847-419c-b3be-a1650ce8992f
 </p></a>
 ++++
 
-This repository hosts the documentation content for Redpanda Self-Managed.
+This repository hosts the documentation content for Redpanda Streaming.
 
 == Contribute
 
@@ -92,7 +92,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:
 

antora.yml

@@ -1,17 +1,23 @@
-name: ROOT
-title: Self-Managed
+name: streaming
+title: Streaming
 version: 24.2
 start_page: home:index.adoc
 nav:
 - modules/ROOT/nav.adoc
 asciidoc:
   attributes:
+    # Product name used throughout the documentation
     # Date of release in the format YYYY-MM-DD
     page-release-date: 2024-07-31
     # Only used in the main branch (latest version)
     page-header-data:
+      title: "Streaming"
+      section: "Data Platform"
+      parent-component: "self-managed"
+      description: "Redpanda broker and rpk CLI for self-managed deployments."
+      color: "#107569"
       order: 2
-      color: '#107569'
+      icon: "activity"
     # Name of the Redpanda UI used in content that is single-sourced with Redpanda Cloud.
     ui: Redpanda Console@
     # Fallback versions
@@ -74,7 +80,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: panda.png # images must be in modules/ROOT/images
     page-home-intro-learn-more: get-started:intro-to-events.adoc
     page-home-primary-row-title: Deploy
@@ -106,16 +112,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: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'

modules/console/pages/config/deserialization.adoc

@@ -33,7 +33,7 @@ kafka:
 ----
 
 - `enabled`: Set to `true` to enable the use of a Schema Registry.
-- `urls`: Provide the URLs to your Schema Registry endpoints. Multiple URLs can be specified for redundancy. To set up the Schema Registry in {ui} with Redpanda Self-Managed, see xref:console:ui/schema-reg.adoc[].
+- `urls`: Provide the URLs to your Schema Registry endpoints. Multiple URLs can be specified for redundancy. To set up the Schema Registry in {ui} with {product-name}, see xref:console:ui/schema-reg.adoc[].
 - `username/password`: Use these fields for basic authentication. For security, it's recommended to use xref:console:config/configure-console.adoc#environment-variables[environment variables] or command-line flags for sensitive information.
 - `bearerToken`: Optionally, use bearer token authentication instead of basic auth.
 - `tls`: If your Schema Registry is secured with TLS, configure the necessary certificates and options.

modules/console/pages/quickstart.adoc

@@ -32,7 +32,7 @@ You should see the version of Docker Compose that's installed on your local mach
 
 . xref:console:attachment$docker-compose.yml[Download] the following Docker Compose file on your local file system.
 +
-This Docker Compose file deploys a Redpanda Self-Managed cluster, Redpanda Console, and Redpanda Connect. Redpanda Connect is used to generate demo data and produce it to a topic on the Redpanda cluster.
+This Docker Compose file deploys a {product-name} cluster, Redpanda Console, and Redpanda Connect. Redpanda Connect is used to generate demo data and produce it to a topic on the Redpanda cluster.
 +
 .Reveal the YAML content
 [%collapsible]
@@ -273,7 +273,7 @@ In the *Connectors* menu, you can manage your Kafka Connect clusters or view ins
 See also:
 
 - xref:console:config/kafka-connect.adoc[Manage Kafka Connect in Redpanda Console]
-- xref:redpanda-connect:ROOT:about.adoc[About Redpanda Connect]
+- xref:connect:streaming:about.adoc[About Redpanda Connect]
 
 == Data transforms
 
@@ -291,10 +291,10 @@ See also:
 
 == Suggested reading
 
-- xref:redpanda-connect:ROOT:about.adoc[Redpanda Connect]
-** xref:redpanda-connect:components:outputs/kafka_franz.adoc[`kafka_franz`] output connector
-** xref:redpanda-connect:components:inputs/generate.adoc[`generate`] input connector
-** xref:redpanda-connect:configuration:processing_pipelines.adoc[processing pipelines]
+- xref:connect:streaming:about.adoc[Redpanda Connect]
+** xref:connect:components:outputs/kafka_franz.adoc[`kafka_franz`] output connector
+** xref:connect:components:inputs/generate.adoc[`generate`] input connector
+** xref:connect:configuration:processing_pipelines.adoc[processing pipelines]
 
 - xref:reference:rpk/index.adoc[`rpk`]
 ** xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`]

modules/deploy/pages/index.adoc

@@ -1,5 +1,5 @@
 = Self-Managed Deployment
-:description: Learn about Redpanda Self-Managed deployments.
+:description: Learn about {product-name} deployments.
 :page-layout: index
 :page-aliases: deployment:index.adoc, deployment:index/index.adoc, deploy:deployment-option/index.adoc, deploy:deployment-option/index/index.adoc, deploy:index/index.adoc, deploy:deployment-option/self-hosted/index.adoc
 :page-categories: Deployment

modules/deploy/partials/kubernetes/guides/next-steps.adoc

@@ -1,6 +1,6 @@
 = Next steps
 
-* xref:redpanda-labs:ROOT:index.adoc[Try an example in Redpanda Labs]
+* xref:labs:ROOT:index.adoc[Try an example in Redpanda Labs]
 * xref:manage:console/index.adoc[Learn more about Redpanda Console]
 * xref:get-started:rpk-install.adoc[Learn more about rpk]
 

modules/develop/pages/consume-data/follower-fetching.adoc

@@ -31,7 +31,7 @@ ifdef::env-cloud[]
 For each consumer, set the `client.rack` property to a rack ID. Rack awareness is pre-enabled for cloud-based clusters in multi-AZ environments.
 endif::[]
 
-include::ROOT:shared:partial$suggested-video.adoc[]
+include::shared:partial$suggested-video.adoc[]
 
 * https://www.youtube.com/watch?v=wV6gH5_yVaw&ab_channel=RedpandaData[YouTube - Redpanda Office Hour: Follower Fetching (52 mins)^]
 

modules/develop/pages/data-transforms/how-transforms-work.adoc

@@ -52,7 +52,7 @@ This section outlines the limitations of data transforms. These constraints are
 === General
 
 - *No external access*: Transform functions have no external access to disk or network resources.
-- *Single record transforms*: Only single record transforms are supported, but multiple output records from a single input record are supported. For aggregations, joins, or complex transformations, consider xref:redpanda-connect:ROOT:about.adoc[Redpanda Connect] or https://flink.apache.org/[Apache Flink^].
+- *Single record transforms*: Only single record transforms are supported, but multiple output records from a single input record are supported. For aggregations, joins, or complex transformations, consider xref:connect:streaming:about.adoc[Redpanda Connect] or https://flink.apache.org/[Apache Flink^].
 - *Output topic limit*: Up to eight output topics are supported.
 - *Delivery semantics*: Transform functions have at-least-once delivery.
 - *Transactions API*: When clients use the Kafka Transactions API on partitions of an input topic, transform functions process only committed records.

modules/develop/partials/http-proxy.adoc

@@ -125,7 +125,7 @@ Curl is likely already installed on your system. If not, see https://curl.se/dow
 NodeJS::
 +
 --
-NOTE: This is based on the assumption that you're in the root directory of an existing NodeJS project. See xref:redpanda-labs:clients:docker-nodejs.adoc[] for an example of a NodeJS project.
+NOTE: This is based on the assumption that you're in the root directory of an existing NodeJS project. See xref:labs:clients:docker-nodejs.adoc[] for an example of a NodeJS project.
 
 In a terminal window, run:
 

modules/get-started/pages/intro-to-events.adoc

@@ -59,21 +59,21 @@ Raft facilitates communication between the nodes in a Redpanda cluster to make s
 +
 With the Bring Your Own Cloud (BYOC) offering, you deploy Redpanda in your own virtual private cloud, and all data is contained in your environment. Redpanda handles provisioning, monitoring, and upgrades, but you manage your streaming data without Redpanda's control plane ever seeing it.
 
-== Redpanda Self-Managed versions
+== {product-name} versions
 
-You can deploy Redpanda in a self-hosted environment (Redpanda Self-Managed) or as a fully managed cloud service (Redpanda Cloud).
+You can deploy Redpanda in a self-hosted environment ({product-name}) or as a fully managed cloud service (Redpanda Cloud).
 
-Redpanda Self-Managed version numbers follow the convention AB.C.D, where AB is the two-digit year, C is the feature release, and D is the patch release. For example, version 22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release.
+{product-name} version numbers follow the convention AB.C.D, where AB is the two-digit year, C is the feature release, and D is the patch release. For example, version 22.3.1 indicates the first patch release on the third feature release of the year 2022. Patch releases include bug fixes and minor improvements, with no change to user-facing behavior. New and enhanced features are documented with each feature release.
 
-Redpanda Cloud releases on a continuous basis and uptakes Redpanda Self-Managed versions.
+Redpanda Cloud releases on a continuous basis and uptakes {product-name} versions.
 
 ifndef::env-cloud[]
 == Next steps
 
 * To spin up a Redpanda cluster to try it out, see xref:./quick-start.adoc[Redpanda Quickstart].
 * To learn more about Redpanda, see xref:./architecture.adoc[How Redpanda Works].
-* For information about a Redpanda Self-Managed deployment, see xref:./licenses.adoc[Redpanda Licensing].
-* For information about a Redpanda Cloud deployment, see xref:redpanda-cloud:get-started:cloud-overview.adoc[].
+* For information about a {product-name} deployment, see xref:./licenses.adoc[Redpanda Licensing].
+* For information about a Redpanda Cloud deployment, see xref:cloud-data-platform:get-started:cloud-overview.adoc[].
 
 include::shared:partial$suggested-reading.adoc[]
 

modules/get-started/pages/licenses.adoc

@@ -1,15 +1,15 @@
 = Redpanda Licensing
-:description: Redpanda Self-Managed is free and source-available at the Redpanda GitHub repo. Additional features are included with an Enterprise license.
+:description: {product-name} is free and source-available at the Redpanda GitHub repo. Additional features are included with an Enterprise license.
 :page-aliases: introduction:licenses.adoc
 
-You can deploy Redpanda in a self-hosted environment (Redpanda Self-Managed) or as a fully-managed cloud service (Redpanda Cloud). For Redpanda Self-Managed, select either the Community Edition or the Enterprise Edition:
+You can deploy Redpanda in a self-hosted environment ({product-name}) or as a fully-managed cloud service (Redpanda Cloud). For {product-name}, select either the Community Edition or the Enterprise Edition:
 
 * Redpanda Community Edition is free and source-available at the https://github.com/redpanda-data/redpanda[Redpanda GitHub repository^].
 * Redpanda Enterprise Edition requires a license key and includes additional features.
 
 [NOTE]
 ====
-To learn about Redpanda Cloud deployments, see the xref:redpanda-cloud:get-started:cloud-overview.adoc[].
+To learn about Redpanda Cloud deployments, see the xref:cloud-data-platform:get-started:cloud-overview.adoc[].
 ====
 
 == Redpanda Community Edition
@@ -37,8 +37,8 @@ Redpanda Enterprise Edition is licensed with the https://github.com/redpanda-dat
 * xref:manage:security/authorization/rbac.adoc[Redpanda Role-Based Access Control (RBAC)]
 * xref:manage:security/console/authorization.adoc[Redpanda Console Authorization (RBAC)]
 * xref:manage:security/console/authentication.adoc[Redpanda Console Authentication]
-* xref:redpanda-connect:components:outputs/snowflake_put.adoc[Snowflake connector for Redpanda Connect]
-* xref:redpanda-connect:components:outputs/splunk_hec.adoc[Splunk connector for Redpanda Connect]
+* xref:connect:components:outputs/snowflake_put.adoc[Snowflake connector for Redpanda Connect]
+* xref:connect:components:outputs/splunk_hec.adoc[Splunk connector for Redpanda Connect]
 
 Enterprise features require a license key. You can evaluate enterprise features with a free 30-day trial. Contact https://redpanda.com/try-redpanda?section=enterprise-trial[Redpanda Sales^] to request a trial license, to extend your trial period, or to purchase an Enterprise Edition license.
 

modules/get-started/pages/quick-start.adoc

@@ -1,17 +1,17 @@
-= Redpanda Self-Managed Quickstart
+= {product-name} Quickstart
 :description: Learn how to quickly start working with a local Redpanda cluster.
 :page-aliases: install-upgrade:index.adoc, install-upgrade:index/index.adoc, install-upgrade:start-streaming.adoc, quickstart:console-installation, quickstart:quick-start-docker.adoc, quickstart:quick-start-linux.adoc, quickstart:quick-start-macos.adoc, quickstart:quick-start-windows.adoc, getting-started:quick-start-docker.adoc, getting-started:quick-start-linux.adoc, getting-started:quick-start-windows.adoc, getting-started:quick-start-macos.adoc, console:installation.adoc, get-started:quick-start/quick-start-console.adoc, get-started:quick-start/quick-start-macos.adoc, get-started:quick-start/quick-start-linux.adoc, get-started:quick-start/quick-start-docker.adoc, get-started:quickstarts/index.adoc
 :page-categories: Deployment, Development, rpk
 :env-docker: true
 
 {description}
 
-This quickstart introduces you to Redpanda Self-Managed in a self-hosted environment with a minimal setup. Docker Compose provides a straightforward and reproducible setup process, whether you're exploring Redpanda for the first time or testing new configurations. The option between a single broker and a three-broker setup helps you test Redpanda for simplicity and resilience.
+This quickstart introduces you to {product-name} in a self-hosted environment with a minimal setup. Docker Compose provides a straightforward and reproducible setup process, whether you're exploring Redpanda for the first time or testing new configurations. The option between a single broker and a three-broker setup helps you test Redpanda for simplicity and resilience.
 
 [NOTE]
 ====
 Redpanda in Docker is supported only for development and testing.
-To deploy Redpanda Self-Managed in production, use one of the following environments:
+To deploy {product-name} in production, use one of the following environments:
 
 - xref:deploy:deployment-option/self-hosted/manual/index.adoc[Linux]
 - xref:deploy:deployment-option/self-hosted/kubernetes/index.adoc[Kubernetes]
@@ -46,15 +46,15 @@ For production environments where you need more resilience, a three-broker setup
 Single Broker::
 +
 --
-. xref:redpanda-labs:docker-compose:attachment$single-broker/docker-compose.yml[Download] the following `docker-compose.yml` file on your local file system.
+. xref:labs:docker-compose:attachment$single-broker/docker-compose.yml[Download] the following `docker-compose.yml` file on your local file system.
 +
 .Reveal the YAML content
 [%collapsible]
 ====
 .`docker-compose.yml`
 [,yaml,subs="attributes+"]
 ----
-include::redpanda-labs:docker-compose:attachment$single-broker/docker-compose.yml[]
+include::labs:docker-compose:attachment$single-broker/docker-compose.yml[]
 ----
 ====
 
@@ -77,15 +77,15 @@ Three Brokers::
 +
 --
 
-. xref:redpanda-labs:docker-compose:attachment$three-brokers/docker-compose.yml[Download] the following `docker-compose.yml` file on your local file system.
+. xref:labs:docker-compose:attachment$three-brokers/docker-compose.yml[Download] the following `docker-compose.yml` file on your local file system.
 +
 .Reveal the YAML content
 [%collapsible]
 ====
 .`docker-compose.yml`
 [,yaml,subs="attributes+"]
 ----
-include::redpanda-labs:docker-compose:attachment$three-brokers/docker-compose.yml[]
+include::labs:docker-compose:attachment$three-brokers/docker-compose.yml[]
 ----
 ====
 
@@ -297,7 +297,7 @@ docker compose down -v
 
 == Next steps
 
-- xref:redpanda-labs:ROOT:index.adoc[Try more examples in Redpanda Labs]
+- xref:labs:ROOT:index.adoc[Try more examples in Redpanda Labs]
 - xref:manage:console/index.adoc[Learn more about Redpanda Console]
 - xref:rpk-install.adoc[Learn more about rpk]
 - xref:deploy:deployment-option/self-hosted/manual/production/index.adoc[Deploy for development or production]

modules/get-started/pages/rpk-install.adoc

@@ -12,7 +12,7 @@ The `rpk` tool is a single binary application that provides a way to interact wi
 * Set up access control lists (ACLs) and other security features
 
 ifndef::env-cloud[]
-For Redpanda Self-Managed deployments, the `rpk` binary is automatically installed on each Redpanda broker, so you can use the locally installed `rpk` binary to communicate with the local Redpanda cluster.
+For {product-name} deployments, the `rpk` binary is automatically installed on each Redpanda broker, so you can use the locally installed `rpk` binary to communicate with the local Redpanda cluster.
 
 You can also install `rpk` on your local machine as a standalone binary. With this setup, you can connect to a Redpanda cluster on your local machine and to an external one on a remote server. If you use `rpk` as a standalone binary to communicate with a Redpanda cluster, your installed version of `rpk` must match the version of Redpanda running in your cluster.
 endif::[]