From 0f5e18006a9c6ed49620c30c83739229c3c89647 Mon Sep 17 00:00:00 2001 From: micheleRP Date: Tue, 4 Aug 2026 16:02:03 -0600 Subject: [PATCH 1/2] Add :description: to every single-source stub with an upstream description Stub pages inherit nothing from their single-source includes: Antora resolves page metadata with a header-only parse, so all of these pages shipped the generic site-wide meta description. This copies each stub's description verbatim from its upstream counterpart (145 rpk stubs from the docs repo, 46 connect stubs from rp-connect-docs) into the stub header, where Antora picks it up. The 234 connect stubs whose upstream has no description yet are unchanged; they are tracked in the CI allowlist added in the next commit. Co-Authored-By: Claude Fable 5 --- modules/develop/pages/connect/components/about.adoc | 1 + modules/develop/pages/connect/components/caches/redpanda.adoc | 1 + .../pages/connect/components/inputs/aws_cloudwatch_logs.adoc | 1 + .../pages/connect/components/inputs/aws_dynamodb_cdc.adoc | 1 + modules/develop/pages/connect/components/inputs/gateway.adoc | 1 + .../develop/pages/connect/components/inputs/gcp_spanner_cdc.adoc | 1 + modules/develop/pages/connect/components/inputs/jira.adoc | 1 + .../connect/components/inputs/microsoft_sql_server_cdc.adoc | 1 + .../develop/pages/connect/components/inputs/oracledb_cdc.adoc | 1 + modules/develop/pages/connect/components/inputs/otlp_grpc.adoc | 1 + modules/develop/pages/connect/components/inputs/otlp_http.adoc | 1 + modules/develop/pages/connect/components/inputs/salesforce.adoc | 1 + .../develop/pages/connect/components/inputs/salesforce_cdc.adoc | 1 + .../pages/connect/components/inputs/salesforce_graphql.adoc | 1 + .../connect/components/metrics/open_telemetry_collector.adoc | 1 + modules/develop/pages/connect/components/outputs/arc.adoc | 1 + modules/develop/pages/connect/components/outputs/cyborgdb.adoc | 1 + modules/develop/pages/connect/components/outputs/drop.adoc | 1 + .../pages/connect/components/outputs/gcp_bigquery_write_api.adoc | 1 + modules/develop/pages/connect/components/outputs/iceberg.adoc | 1 + modules/develop/pages/connect/components/outputs/otlp_grpc.adoc | 1 + modules/develop/pages/connect/components/outputs/otlp_http.adoc | 1 + .../pages/connect/components/outputs/salesforce_sink.adoc | 1 + .../develop/pages/connect/components/outputs/slack_reaction.adoc | 1 + .../develop/pages/connect/components/processors/a2a_message.adoc | 1 + modules/develop/pages/connect/components/processors/jira.adoc | 1 + .../pages/connect/components/processors/string_split.adoc | 1 + .../develop/pages/connect/components/processors/try_catch.adoc | 1 + .../develop/pages/connect/components/scanners/json_array.adoc | 1 + .../connect/components/tracers/open_telemetry_collector.adoc | 1 + modules/develop/pages/connect/components/tracers/redpanda.adoc | 1 + modules/develop/pages/connect/configuration/about.adoc | 1 + .../develop/pages/connect/configuration/windowed_processing.adoc | 1 + modules/develop/pages/connect/cookbooks/dynamodb_cdc.adoc | 1 + modules/develop/pages/connect/cookbooks/enrichments.adoc | 1 + modules/develop/pages/connect/cookbooks/filtering.adoc | 1 + modules/develop/pages/connect/cookbooks/joining_streams.adoc | 1 + modules/develop/pages/connect/guides/bloblang/about.adoc | 1 + modules/develop/pages/connect/guides/bloblang/arithmetic.adoc | 1 + modules/develop/pages/connect/guides/bloblang/functions.adoc | 1 + modules/develop/pages/connect/guides/bloblang/methods.adoc | 1 + modules/develop/pages/connect/guides/bloblang/walkthrough.adoc | 1 + modules/develop/pages/connect/guides/cloud/aws-iam-aurora.adoc | 1 + modules/develop/pages/connect/guides/cloud/aws.adoc | 1 + modules/develop/pages/connect/guides/cloud/gcp.adoc | 1 + modules/develop/pages/connect/guides/sync_responses.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-delete.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-list.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-use.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth.adoc | 1 + .../reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-install.adoc | 1 + .../reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-uninstall.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc.adoc | 1 + .../reference/pages/rpk/rpk-cloud/rpk-cloud-cluster-select.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-cluster.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-login.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-logout.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-proxy.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp.adoc | 1 + modules/reference/pages/rpk/rpk-cloud/rpk-cloud.adoc | 1 + .../reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc | 1 + .../reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc | 1 + .../reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc | 1 + modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-connections-list.adoc | 1 + .../reference/pages/rpk/rpk-cluster/rpk-cluster-connections.adoc | 1 + modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc | 1 + modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc | 1 + modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc | 1 + .../rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc | 1 + modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc | 1 + .../rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc | 1 + .../pages/rpk/rpk-cluster/rpk-cluster-txn-describe.adoc | 1 + .../reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc | 1 + modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc | 1 + modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc | 1 + modules/reference/pages/rpk/rpk-commands.adoc | 1 + modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc | 1 + .../pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc | 1 + .../pages/rpk/rpk-generate/rpk-generate-shell-completion.adoc | 1 + modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc | 1 + modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc | 1 + modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc | 1 + modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc | 1 + .../reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc | 1 + modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc | 1 + modules/reference/pages/rpk/rpk-group/rpk-group.adoc | 1 + modules/reference/pages/rpk/rpk-help.adoc | 1 + modules/reference/pages/rpk/rpk-plugin/rpk-plugin-install.adoc | 1 + modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc | 1 + modules/reference/pages/rpk/rpk-plugin/rpk-plugin-uninstall.adoc | 1 + modules/reference/pages/rpk/rpk-plugin/rpk-plugin.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-clear.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-create.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-current.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-delete.adoc | 1 + .../pages/rpk/rpk-profile/rpk-profile-edit-globals.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc | 1 + .../pages/rpk/rpk-profile/rpk-profile-print-globals.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-print.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc | 1 + .../reference/pages/rpk/rpk-profile/rpk-profile-rename-to.adoc | 1 + .../reference/pages/rpk/rpk-profile/rpk-profile-set-globals.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile-use.adoc | 1 + modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc | 1 + .../rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc | 1 + .../rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-compatibility-level.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-context-delete.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-context-list.adoc | 1 + .../reference/pages/rpk/rpk-registry/rpk-registry-context.adoc | 1 + .../reference/pages/rpk/rpk-registry/rpk-registry-mode-get.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-mode-reset.adoc | 1 + .../reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc | 1 + modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc | 1 + .../rpk-registry/rpk-registry-schema-check-compatibility.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-schema-create.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-schema-delete.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-schema-get.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-schema-list.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-schema-references.adoc | 1 + .../reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-subject-delete.adoc | 1 + .../pages/rpk/rpk-registry/rpk-registry-subject-list.adoc | 1 + .../reference/pages/rpk/rpk-registry/rpk-registry-subject.adoc | 1 + modules/reference/pages/rpk/rpk-registry/rpk-registry.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-acl-create.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-acl-delete.adoc | 1 + .../reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc | 1 + modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-role-assign.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-role-create.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-role-delete.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-role-describe.adoc | 1 + .../reference/pages/rpk/rpk-security/rpk-security-role-list.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-role-unassign.adoc | 1 + modules/reference/pages/rpk/rpk-security/rpk-security-role.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-secret-create.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-secret-delete.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-secret-list.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-secret-update.adoc | 1 + .../reference/pages/rpk/rpk-security/rpk-security-secret.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-user-create.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-user-delete.adoc | 1 + .../reference/pages/rpk/rpk-security/rpk-security-user-list.adoc | 1 + .../pages/rpk/rpk-security/rpk-security-user-update.adoc | 1 + modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc | 1 + modules/reference/pages/rpk/rpk-security/rpk-security.adoc | 1 + .../pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc | 1 + modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc | 1 + modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc | 1 + modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc | 1 + modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc | 1 + modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc | 1 + modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc | 1 + modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc | 1 + modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc | 1 + .../reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc | 1 + .../reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc | 1 + modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc | 1 + modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc | 1 + modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc | 1 + modules/reference/pages/rpk/rpk-topic/rpk-topic-describe.adoc | 1 + modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc | 1 + modules/reference/pages/rpk/rpk-topic/rpk-topic-produce.adoc | 1 + modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc | 1 + modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc | 1 + .../reference/pages/rpk/rpk-transform/rpk-transform-build.adoc | 1 + .../reference/pages/rpk/rpk-transform/rpk-transform-delete.adoc | 1 + .../reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc | 1 + .../reference/pages/rpk/rpk-transform/rpk-transform-init.adoc | 1 + .../reference/pages/rpk/rpk-transform/rpk-transform-list.adoc | 1 + .../reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc | 1 + modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc | 1 + modules/reference/pages/rpk/rpk-version.adoc | 1 + modules/reference/pages/rpk/rpk-x-options.adoc | 1 + 191 files changed, 191 insertions(+) diff --git a/modules/develop/pages/connect/components/about.adoc b/modules/develop/pages/connect/components/about.adoc index 0188a5382..97b47ce3b 100644 --- a/modules/develop/pages/connect/components/about.adoc +++ b/modules/develop/pages/connect/components/about.adoc @@ -1,4 +1,5 @@ = Components Catalog :page-aliases: components:about.adoc, develop:connect/components/catalog.adoc, components:catalog.adoc +:description: A searchable catalog of available Redpanda Connect components. include::connect:components:about.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/components/caches/redpanda.adoc b/modules/develop/pages/connect/components/caches/redpanda.adoc index 3e5bd8e58..9770e3c49 100644 --- a/modules/develop/pages/connect/components/caches/redpanda.adoc +++ b/modules/develop/pages/connect/components/caches/redpanda.adoc @@ -1,3 +1,4 @@ = redpanda :page-aliases: components:caches/redpanda.adoc +:description: A Kafka cache using the https://github.com/twmb/franz-go[Franz Kafka client library^]. include::connect:components:caches/redpanda.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/inputs/aws_cloudwatch_logs.adoc b/modules/develop/pages/connect/components/inputs/aws_cloudwatch_logs.adoc index 9b20a9d34..a5d21d828 100644 --- a/modules/develop/pages/connect/components/inputs/aws_cloudwatch_logs.adoc +++ b/modules/develop/pages/connect/components/inputs/aws_cloudwatch_logs.adoc @@ -1,3 +1,4 @@ = aws_cloudwatch_logs :page-aliases: components:inputs/aws_cloudwatch_logs.adoc +:description: Consumes log events from AWS CloudWatch Logs. include::connect:components:inputs/aws_cloudwatch_logs.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/inputs/aws_dynamodb_cdc.adoc b/modules/develop/pages/connect/components/inputs/aws_dynamodb_cdc.adoc index 8d5d5714d..40006e054 100644 --- a/modules/develop/pages/connect/components/inputs/aws_dynamodb_cdc.adoc +++ b/modules/develop/pages/connect/components/inputs/aws_dynamodb_cdc.adoc @@ -1,3 +1,4 @@ = aws_dynamodb_cdc :page-aliases: components:inputs/aws_dynamodb_cdc.adoc +:description: Reads change data capture (CDC) events from DynamoDB Streams. include::connect:components:inputs/aws_dynamodb_cdc.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/components/inputs/gateway.adoc b/modules/develop/pages/connect/components/inputs/gateway.adoc index 343b13fa2..b698e1c11 100644 --- a/modules/develop/pages/connect/components/inputs/gateway.adoc +++ b/modules/develop/pages/connect/components/inputs/gateway.adoc @@ -1,4 +1,5 @@ = gateway :page-aliases: components:inputs/gateway.adoc +:description: Receive messages delivered over HTTP. include::connect:components:partial$components/inputs/gateway.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/components/inputs/gcp_spanner_cdc.adoc b/modules/develop/pages/connect/components/inputs/gcp_spanner_cdc.adoc index 24eefedf1..9f8810d60 100644 --- a/modules/develop/pages/connect/components/inputs/gcp_spanner_cdc.adoc +++ b/modules/develop/pages/connect/components/inputs/gcp_spanner_cdc.adoc @@ -1,3 +1,4 @@ = gcp_spanner_cdc :page-aliases: components:inputs/gcp_spanner_cdc.adoc +:description: Creates an input that consumes from a spanner change stream. include::connect:components:inputs/gcp_spanner_cdc.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/inputs/jira.adoc b/modules/develop/pages/connect/components/inputs/jira.adoc index 923b07c68..baa69b656 100644 --- a/modules/develop/pages/connect/components/inputs/jira.adoc +++ b/modules/develop/pages/connect/components/inputs/jira.adoc @@ -1,4 +1,5 @@ = jira :page-aliases: components:inputs/jira.adoc +:description: Streams Jira issues, comments, or changelog entries via JQL with incremental polling. include::connect:components:inputs/jira.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/inputs/microsoft_sql_server_cdc.adoc b/modules/develop/pages/connect/components/inputs/microsoft_sql_server_cdc.adoc index 50c25fb92..dc0a66bc5 100644 --- a/modules/develop/pages/connect/components/inputs/microsoft_sql_server_cdc.adoc +++ b/modules/develop/pages/connect/components/inputs/microsoft_sql_server_cdc.adoc @@ -1,3 +1,4 @@ = microsoft_sql_server_cdc :page-aliases: components:inputs/microsoft_sql_server_cdc.adoc +:description: Enables Change Data Capture by consuming from Microsoft SQL Server's change tables. include::connect:components:inputs/microsoft_sql_server_cdc.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/components/inputs/oracledb_cdc.adoc b/modules/develop/pages/connect/components/inputs/oracledb_cdc.adoc index 6b9ffc5dd..48570f0bf 100644 --- a/modules/develop/pages/connect/components/inputs/oracledb_cdc.adoc +++ b/modules/develop/pages/connect/components/inputs/oracledb_cdc.adoc @@ -1,3 +1,4 @@ = oracledb_cdc :page-aliases: components:inputs/oracledb_cdc.adoc +:description: Enables Change Data Capture by consuming from OracleDB. include::connect:components:page$inputs/oracledb_cdc.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/inputs/otlp_grpc.adoc b/modules/develop/pages/connect/components/inputs/otlp_grpc.adoc index 89179dc9b..34d32e5d8 100644 --- a/modules/develop/pages/connect/components/inputs/otlp_grpc.adoc +++ b/modules/develop/pages/connect/components/inputs/otlp_grpc.adoc @@ -1,3 +1,4 @@ = otlp_grpc +:description: Receive OpenTelemetry traces, logs, and metrics via OTLP/gRPC protocol. include::connect:components:inputs/otlp_grpc.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/inputs/otlp_http.adoc b/modules/develop/pages/connect/components/inputs/otlp_http.adoc index b86582dc9..1631f5e38 100644 --- a/modules/develop/pages/connect/components/inputs/otlp_http.adoc +++ b/modules/develop/pages/connect/components/inputs/otlp_http.adoc @@ -1,3 +1,4 @@ = otlp_http +:description: Receive OpenTelemetry traces, logs, and metrics via OTLP/HTTP protocol. include::connect:components:inputs/otlp_http.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/inputs/salesforce.adoc b/modules/develop/pages/connect/components/inputs/salesforce.adoc index a3aa16421..8fdfc8b4b 100644 --- a/modules/develop/pages/connect/components/inputs/salesforce.adoc +++ b/modules/develop/pages/connect/components/inputs/salesforce.adoc @@ -1,3 +1,4 @@ = salesforce :page-aliases: components:inputs/salesforce.adoc +:description: Runs a SOQL query against the Salesforce REST API, paginates through all result pages, and emits one message per record. include::connect:components:inputs/salesforce.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/inputs/salesforce_cdc.adoc b/modules/develop/pages/connect/components/inputs/salesforce_cdc.adoc index 8fd96ebd9..17ffa441c 100644 --- a/modules/develop/pages/connect/components/inputs/salesforce_cdc.adoc +++ b/modules/develop/pages/connect/components/inputs/salesforce_cdc.adoc @@ -1,4 +1,5 @@ = salesforce_cdc :page-aliases: components:inputs/salesforce_cdc.adoc +:description: Subscribes to one or more Salesforce Pub/Sub topics in parallel and emits a message per event. include::connect:components:inputs/salesforce_cdc.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/inputs/salesforce_graphql.adoc b/modules/develop/pages/connect/components/inputs/salesforce_graphql.adoc index a17690d8d..0cfd128a0 100644 --- a/modules/develop/pages/connect/components/inputs/salesforce_graphql.adoc +++ b/modules/develop/pages/connect/components/inputs/salesforce_graphql.adoc @@ -1,4 +1,5 @@ = salesforce_graphql :page-aliases: components:inputs/salesforce_graphql.adoc +:description: Executes a GraphQL query against the Salesforce UIAPI and emits one message per record. include::connect:components:inputs/salesforce_graphql.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/metrics/open_telemetry_collector.adoc b/modules/develop/pages/connect/components/metrics/open_telemetry_collector.adoc index 3cbfadb00..b803b0b5d 100644 --- a/modules/develop/pages/connect/components/metrics/open_telemetry_collector.adoc +++ b/modules/develop/pages/connect/components/metrics/open_telemetry_collector.adoc @@ -1,3 +1,4 @@ = open_telemetry_collector :page-aliases: components:metrics/open_telemetry_collector.adoc +:description: Send metrics to an https://opentelemetry.io/docs/collector/[Open Telemetry collector^]. include::connect:components:metrics/open_telemetry_collector.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/outputs/arc.adoc b/modules/develop/pages/connect/components/outputs/arc.adoc index 6b7fbdc77..46b3acc8c 100644 --- a/modules/develop/pages/connect/components/outputs/arc.adoc +++ b/modules/develop/pages/connect/components/outputs/arc.adoc @@ -1,3 +1,4 @@ = arc :page-aliases: components:outputs/arc.adoc +:description: Writes data to an Arc database via the msgpack ingestion endpoint. include::connect:components:outputs/arc.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/outputs/cyborgdb.adoc b/modules/develop/pages/connect/components/outputs/cyborgdb.adoc index f61052fcd..692ab2e72 100644 --- a/modules/develop/pages/connect/components/outputs/cyborgdb.adoc +++ b/modules/develop/pages/connect/components/outputs/cyborgdb.adoc @@ -1,3 +1,4 @@ = cyborgdb :page-aliases: components:outputs/cyborgdb.adoc +:description: Inserts items into a CyborgDB encrypted vector index. include::connect:components:outputs/cyborgdb.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/components/outputs/drop.adoc b/modules/develop/pages/connect/components/outputs/drop.adoc index e6e4dfb0a..910bb3c6e 100644 --- a/modules/develop/pages/connect/components/outputs/drop.adoc +++ b/modules/develop/pages/connect/components/outputs/drop.adoc @@ -1,3 +1,4 @@ = drop :page-aliases: components:outputs/drop.adoc +:description: Drop output reference for silently discarding messages in Redpanda Connect pipelines. include::connect:components:outputs/drop.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/components/outputs/gcp_bigquery_write_api.adoc b/modules/develop/pages/connect/components/outputs/gcp_bigquery_write_api.adoc index cd11aa28b..36ac180c4 100644 --- a/modules/develop/pages/connect/components/outputs/gcp_bigquery_write_api.adoc +++ b/modules/develop/pages/connect/components/outputs/gcp_bigquery_write_api.adoc @@ -1,3 +1,4 @@ = gcp_bigquery_write_api :page-aliases: components:outputs/gcp_bigquery_write_api.adoc +:description: Streams data into BigQuery using the Storage Write API. include::connect:components:outputs/gcp_bigquery_write_api.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/outputs/iceberg.adoc b/modules/develop/pages/connect/components/outputs/iceberg.adoc index 3ba6e548c..49d2ed0cd 100644 --- a/modules/develop/pages/connect/components/outputs/iceberg.adoc +++ b/modules/develop/pages/connect/components/outputs/iceberg.adoc @@ -1,3 +1,4 @@ = iceberg :page-aliases: components:outputs/iceberg.adoc +:description: Fan out Redpanda topics to Apache Iceberg tables using the REST catalog API. include::connect:components:outputs/iceberg.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/outputs/otlp_grpc.adoc b/modules/develop/pages/connect/components/outputs/otlp_grpc.adoc index 6b9e85fe7..39fd9d05c 100644 --- a/modules/develop/pages/connect/components/outputs/otlp_grpc.adoc +++ b/modules/develop/pages/connect/components/outputs/otlp_grpc.adoc @@ -1,3 +1,4 @@ = otlp_grpc +:description: Send OpenTelemetry traces, logs, and metrics via OTLP/gRPC protocol. include::connect:components:outputs/otlp_grpc.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/outputs/otlp_http.adoc b/modules/develop/pages/connect/components/outputs/otlp_http.adoc index 41a125b68..2eea18303 100644 --- a/modules/develop/pages/connect/components/outputs/otlp_http.adoc +++ b/modules/develop/pages/connect/components/outputs/otlp_http.adoc @@ -1,3 +1,4 @@ = otlp_http +:description: Send OpenTelemetry traces, logs, and metrics via OTLP/HTTP protocol. include::connect:components:outputs/otlp_http.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/outputs/salesforce_sink.adoc b/modules/develop/pages/connect/components/outputs/salesforce_sink.adoc index 87e1f8c47..dd7a46a00 100644 --- a/modules/develop/pages/connect/components/outputs/salesforce_sink.adoc +++ b/modules/develop/pages/connect/components/outputs/salesforce_sink.adoc @@ -1,3 +1,4 @@ = salesforce_sink :page-aliases: components:outputs/salesforce_sink.adoc +:description: Writes messages to Salesforce, routing each Kafka topic to its own sObject configuration. include::connect:components:outputs/salesforce_sink.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/outputs/slack_reaction.adoc b/modules/develop/pages/connect/components/outputs/slack_reaction.adoc index ce5240d63..5c7becb9f 100644 --- a/modules/develop/pages/connect/components/outputs/slack_reaction.adoc +++ b/modules/develop/pages/connect/components/outputs/slack_reaction.adoc @@ -1,3 +1,4 @@ = slack_reaction :page-aliases: components:outputs/slack_reaction.adoc +:description: Add or remove an emoji reaction to a Slack message. include::connect:components:outputs/slack_reaction.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/processors/a2a_message.adoc b/modules/develop/pages/connect/components/processors/a2a_message.adoc index f5f89102b..7bd432a1c 100644 --- a/modules/develop/pages/connect/components/processors/a2a_message.adoc +++ b/modules/develop/pages/connect/components/processors/a2a_message.adoc @@ -1,3 +1,4 @@ = a2a_message :page-aliases: components:processors/a2a_message.adoc +:description: Sends messages to an A2A (Agent-to-Agent) protocol agent and returns the response. include::connect:components:partial$components/cloud-only/processors/a2a_message.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/processors/jira.adoc b/modules/develop/pages/connect/components/processors/jira.adoc index b98f537d2..cceffbce1 100644 --- a/modules/develop/pages/connect/components/processors/jira.adoc +++ b/modules/develop/pages/connect/components/processors/jira.adoc @@ -1,3 +1,4 @@ = jira :page-aliases: components:processors/jira.adoc +:description: Queries Jira resources and returns structured data. include::connect:components:processors/jira.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/components/processors/string_split.adoc b/modules/develop/pages/connect/components/processors/string_split.adoc index 0d5526ca0..09c2c38f0 100644 --- a/modules/develop/pages/connect/components/processors/string_split.adoc +++ b/modules/develop/pages/connect/components/processors/string_split.adoc @@ -1,4 +1,5 @@ = string_split :page-aliases: components:processors/string_split.adoc +:description: Splits a string by a delimiter into an array. Generally, using bloblang's `split` method is preferred. In some high performance use cases this processor can be faster than the equivalent bloblang if there is no additional logic. include::connect:components:processors/string_split.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/processors/try_catch.adoc b/modules/develop/pages/connect/components/processors/try_catch.adoc index 9bcbe5fcb..f94f31aa5 100644 --- a/modules/develop/pages/connect/components/processors/try_catch.adoc +++ b/modules/develop/pages/connect/components/processors/try_catch.adoc @@ -1,4 +1,5 @@ = try_catch :page-aliases: components:processors/try_catch.adoc +:description: Executes a list of child `processors` on each message and, if any of them fail, executes a separate list of `catch` processors to recover from or react to the error. include::connect:components:processors/try_catch.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/scanners/json_array.adoc b/modules/develop/pages/connect/components/scanners/json_array.adoc index e954e3481..a50d2490a 100644 --- a/modules/develop/pages/connect/components/scanners/json_array.adoc +++ b/modules/develop/pages/connect/components/scanners/json_array.adoc @@ -1,3 +1,4 @@ = json_array :page-aliases: components:scanners/json_array.adoc +:description: Consumes a stream of one or more JSON elements within a top level array. include::connect:components:scanners/json_array.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/components/tracers/open_telemetry_collector.adoc b/modules/develop/pages/connect/components/tracers/open_telemetry_collector.adoc index 233349f44..53bfacd0c 100644 --- a/modules/develop/pages/connect/components/tracers/open_telemetry_collector.adoc +++ b/modules/develop/pages/connect/components/tracers/open_telemetry_collector.adoc @@ -1,3 +1,4 @@ = open_telemetry_collector :page-aliases: components:tracers/open_telemetry_collector.adoc +:description: Send tracing events to an https://opentelemetry.io/docs/collector/[Open Telemetry collector^]. include::connect:components:tracers/open_telemetry_collector.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/components/tracers/redpanda.adoc b/modules/develop/pages/connect/components/tracers/redpanda.adoc index d4713770e..ee5457c1f 100644 --- a/modules/develop/pages/connect/components/tracers/redpanda.adoc +++ b/modules/develop/pages/connect/components/tracers/redpanda.adoc @@ -1,3 +1,4 @@ = redpanda :page-aliases: components:tracers/redpanda.adoc +:description: Send tracing events to a Redpanda topic. include::connect:components:tracers/redpanda.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/configuration/about.adoc b/modules/develop/pages/connect/configuration/about.adoc index 390cca562..7193998b6 100644 --- a/modules/develop/pages/connect/configuration/about.adoc +++ b/modules/develop/pages/connect/configuration/about.adoc @@ -1,3 +1,4 @@ = Configuration :page-aliases: configuration:about.adoc +:description: Learn about different options for configuring Redpanda Connect. include::connect:configuration:about.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/configuration/windowed_processing.adoc b/modules/develop/pages/connect/configuration/windowed_processing.adoc index 583a1f821..ec25b4d1e 100644 --- a/modules/develop/pages/connect/configuration/windowed_processing.adoc +++ b/modules/develop/pages/connect/configuration/windowed_processing.adoc @@ -1,3 +1,4 @@ = Windowed Processing :page-aliases: configuration:windowed_processing.adoc +:description: Learn how to process periodic windows of messages with Redpanda Connect. include::connect:configuration:windowed_processing.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/cookbooks/dynamodb_cdc.adoc b/modules/develop/pages/connect/cookbooks/dynamodb_cdc.adoc index e80b9e9bd..3b345b2b9 100644 --- a/modules/develop/pages/connect/cookbooks/dynamodb_cdc.adoc +++ b/modules/develop/pages/connect/cookbooks/dynamodb_cdc.adoc @@ -1,3 +1,4 @@ = DynamoDB CDC Patterns :page-aliases: cookbooks:dynamodb_cdc.adoc +:description: Learn how to capture, filter, transform, and route DynamoDB change data capture (CDC) events with Redpanda Connect. include::connect:cookbooks:dynamodb_cdc.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/cookbooks/enrichments.adoc b/modules/develop/pages/connect/cookbooks/enrichments.adoc index 0173f602f..6163d8832 100644 --- a/modules/develop/pages/connect/cookbooks/enrichments.adoc +++ b/modules/develop/pages/connect/cookbooks/enrichments.adoc @@ -1,3 +1,4 @@ = Enrichment Workflows :page-aliases: cookbooks:enrichments.adoc +:description: How to configure Redpanda Connect to process a workflow of enrichment services. include::connect:cookbooks:enrichments.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/cookbooks/filtering.adoc b/modules/develop/pages/connect/cookbooks/filtering.adoc index 28d039648..123549433 100644 --- a/modules/develop/pages/connect/cookbooks/filtering.adoc +++ b/modules/develop/pages/connect/cookbooks/filtering.adoc @@ -1,3 +1,4 @@ = Filtering and Sampling :page-aliases: cookbooks:filtering.adoc +:description: Configure Redpanda Connect to conditionally drop messages. include::connect:cookbooks:filtering.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/cookbooks/joining_streams.adoc b/modules/develop/pages/connect/cookbooks/joining_streams.adoc index be44c6384..0e591b40c 100644 --- a/modules/develop/pages/connect/cookbooks/joining_streams.adoc +++ b/modules/develop/pages/connect/cookbooks/joining_streams.adoc @@ -1,3 +1,4 @@ = Joining Streams :page-aliases: cookbooks:joining_streams.adoc +:description: How to hydrate documents by joining multiple streams. include::connect:cookbooks:joining_streams.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/guides/bloblang/about.adoc b/modules/develop/pages/connect/guides/bloblang/about.adoc index 0ff484105..92887241d 100644 --- a/modules/develop/pages/connect/guides/bloblang/about.adoc +++ b/modules/develop/pages/connect/guides/bloblang/about.adoc @@ -1,3 +1,4 @@ = Bloblang :page-aliases: guides:bloblang/about.adoc +:description: Learn what Bloblang is and how to use the native mapping language. include::connect:guides:bloblang/about.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/guides/bloblang/arithmetic.adoc b/modules/develop/pages/connect/guides/bloblang/arithmetic.adoc index fb211321f..64177860c 100644 --- a/modules/develop/pages/connect/guides/bloblang/arithmetic.adoc +++ b/modules/develop/pages/connect/guides/bloblang/arithmetic.adoc @@ -1,3 +1,4 @@ = Bloblang Arithmetic :page-aliases: guides:bloblang/arithmetic.adoc +:description: How arithmetic works within Bloblang include::connect:guides:bloblang/arithmetic.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/guides/bloblang/functions.adoc b/modules/develop/pages/connect/guides/bloblang/functions.adoc index 4007a4f38..f71926196 100644 --- a/modules/develop/pages/connect/guides/bloblang/functions.adoc +++ b/modules/develop/pages/connect/guides/bloblang/functions.adoc @@ -1,3 +1,4 @@ = Bloblang Functions :page-aliases: guides:bloblang/functions.adoc +:description: A list of Bloblang functions include::connect:guides:bloblang/functions.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/guides/bloblang/methods.adoc b/modules/develop/pages/connect/guides/bloblang/methods.adoc index 1ec291ffe..eb8e9c52e 100644 --- a/modules/develop/pages/connect/guides/bloblang/methods.adoc +++ b/modules/develop/pages/connect/guides/bloblang/methods.adoc @@ -1,3 +1,4 @@ = Bloblang Methods :page-aliases: guides:bloblang/methods.adoc +:description: A list of Bloblang methods include::connect:guides:bloblang/methods.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/guides/bloblang/walkthrough.adoc b/modules/develop/pages/connect/guides/bloblang/walkthrough.adoc index d9a1cb224..229e64526 100644 --- a/modules/develop/pages/connect/guides/bloblang/walkthrough.adoc +++ b/modules/develop/pages/connect/guides/bloblang/walkthrough.adoc @@ -1,3 +1,4 @@ = Bloblang Walkthrough :page-aliases: guides:bloblang/walkthrough.adoc +:description: A step by step introduction to Bloblang include::connect:guides:bloblang/walkthrough.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/guides/cloud/aws-iam-aurora.adoc b/modules/develop/pages/connect/guides/cloud/aws-iam-aurora.adoc index 6fa5fd7eb..6c6b6d7bb 100644 --- a/modules/develop/pages/connect/guides/cloud/aws-iam-aurora.adoc +++ b/modules/develop/pages/connect/guides/cloud/aws-iam-aurora.adoc @@ -1,3 +1,4 @@ = Authenticate to Amazon Aurora using IAM roles :page-aliases: guides:cloud/aws-iam-aurora.adoc +:description: Configure IAM roles to authenticate Redpanda Connect pipelines to Amazon Aurora on AWS without static credentials. include::connect:guides:cloud/aws-iam-aurora.adoc[tag=single-source] diff --git a/modules/develop/pages/connect/guides/cloud/aws.adoc b/modules/develop/pages/connect/guides/cloud/aws.adoc index 84b2e6bda..94886e03f 100644 --- a/modules/develop/pages/connect/guides/cloud/aws.adoc +++ b/modules/develop/pages/connect/guides/cloud/aws.adoc @@ -1,3 +1,4 @@ = Amazon Web Services :page-aliases: guides:cloud/aws.adoc +:description: Find out about AWS components in Redpanda Connect. include::connect:guides:cloud/aws.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/guides/cloud/gcp.adoc b/modules/develop/pages/connect/guides/cloud/gcp.adoc index cd2c08a55..b638721fa 100644 --- a/modules/develop/pages/connect/guides/cloud/gcp.adoc +++ b/modules/develop/pages/connect/guides/cloud/gcp.adoc @@ -1,3 +1,4 @@ = Google Cloud Platform :page-aliases: guides:cloud/gcp.adoc +:description: Find out about GCP components in Redpanda Connect. include::connect:guides:cloud/gcp.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/develop/pages/connect/guides/sync_responses.adoc b/modules/develop/pages/connect/guides/sync_responses.adoc index dabadbe95..5feff5d29 100644 --- a/modules/develop/pages/connect/guides/sync_responses.adoc +++ b/modules/develop/pages/connect/guides/sync_responses.adoc @@ -1,3 +1,4 @@ = Synchronous Responses :page-aliases: guides:sync_responses.adoc +:description: Understand synchronous response handling in Redpanda Connect, ensuring reliable and efficient data processing. include::connect:guides:sync_responses.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-delete.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-delete.adoc index c3cee7488..595d58c0d 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-delete.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-delete.adoc @@ -1,3 +1,4 @@ = rpk cloud auth delete +:description: pass:q[Delete an `rpk` cloud authentication. Deleting a cloud authentication removes it from the `rpk.yaml` file.] include::streaming:reference:partial$rpk-cloud/rpk-cloud-auth-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-list.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-list.adoc index 78f2eebea..ac31db434 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-list.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-list.adoc @@ -1,3 +1,4 @@ = rpk cloud auth list +:description: pass:q[List `rpk` cloud authentications.] include::streaming:reference:partial$rpk-cloud/rpk-cloud-auth-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc index 5bb86759a..a921b523c 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc @@ -1,3 +1,4 @@ = rpk cloud auth token +:description: Print the cloud auth token of the current profile. This command prints the auth token for the currently selected cloud authentication to stdout. include::streaming:reference:partial$rpk-cloud/rpk-cloud-auth-token.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-use.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-use.adoc index 679db806e..5f78bc805 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-use.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-use.adoc @@ -1,3 +1,4 @@ = rpk cloud auth use +:description: pass:q[Select the `rpk` cloud authentication to use. This swaps the current cloud authentication to the specified cloud authentication.] include::streaming:reference:partial$rpk-cloud/rpk-cloud-auth-use.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth.adoc index 313a5d74f..6b3cb9187 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth.adoc @@ -1,3 +1,4 @@ = rpk cloud auth +:description: pass:q[Manage `rpk` cloud authentications. An `rpk` cloud authentication allows you to talk to Redpanda Cloud.] include::streaming:reference:partial$rpk-cloud/rpk-cloud-auth.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-install.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-install.adoc index 1c7191c8a..16bf37746 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-install.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-install.adoc @@ -1,3 +1,4 @@ = rpk cloud byoc install +:description: Install the BYOC plugin. This command downloads the BYOC managed plugin if necessary. include::streaming:reference:partial$rpk-cloud/rpk-cloud-byoc-install.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-uninstall.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-uninstall.adoc index 1dacfb75e..b8d30f322 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-uninstall.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc-uninstall.adoc @@ -1,3 +1,4 @@ = rpk cloud byoc uninstall +:description: Uninstall the BYOC plugin. This command deletes your locally downloaded BYOC managed plugin if it exists. include::streaming:reference:partial$rpk-cloud/rpk-cloud-byoc-uninstall.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc.adoc index 3b3fdb251..0f8150270 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-byoc.adoc @@ -1,3 +1,4 @@ = rpk cloud byoc +:description: Manage a Redpanda Cloud BYOC agent. For BYOC, Redpanda installs an agent service in your owned cluster. include::streaming:reference:partial$rpk-cloud/rpk-cloud-byoc.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-cluster-select.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-cluster-select.adoc index 92cd578de..0b894edb0 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-cluster-select.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-cluster-select.adoc @@ -1,3 +1,4 @@ = rpk cloud cluster select +:description: Update your rpk profile to talk to the requested cluster. include::streaming:reference:partial$rpk-cloud/rpk-cloud-cluster-select.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-cluster.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-cluster.adoc index d90cf2bdc..6f019f751 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-cluster.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-cluster.adoc @@ -1,3 +1,4 @@ = rpk cloud cluster +:description: pass:q[Manage `rpk` cloud clusters. This command allows you to manage cloud clusters, as well as easily switch between which cluster you are talking to.] include::streaming:reference:partial$rpk-cloud/rpk-cloud-cluster.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-login.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-login.adoc index c67bba234..843d1a019 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-login.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-login.adoc @@ -1,3 +1,4 @@ = rpk cloud login +:description: Log in to the Redpanda Cloud. This command checks for an existing Redpanda Cloud API token and, if present, ensures it is still valid. include::streaming:reference:partial$rpk-cloud/rpk-cloud-login.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-logout.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-logout.adoc index 7492f0b25..8720e293d 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-logout.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-logout.adoc @@ -1,3 +1,4 @@ = rpk cloud logout +:description: Log out from Redpanda Cloud. This command deletes your cloud auth token. include::streaming:reference:partial$rpk-cloud/rpk-cloud-logout.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc index bd49810e1..875cfb170 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-install.adoc @@ -1,3 +1,4 @@ = rpk cloud mcp install +:description: Install the MCP client configuration to connect your AI assistant to the local MCP server for Redpanda Cloud. This command generates and installs the necessary configuration files for your MCP client (like Claude Code) to automatically connect to the local MCP server for Redpanda Cloud. include::streaming:reference:partial$rpk-cloud/rpk-cloud-mcp-install.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-proxy.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-proxy.adoc index e2b734e2d..58fbd58d0 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-proxy.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-proxy.adoc @@ -1,3 +1,4 @@ = rpk cloud mcp proxy +:description: Proxy MCP requests to a remote Redpanda Cloud MCP server. This command connects to a specific cluster and MCP server running in that cluster, then proxies MCP requests from stdio to the remote MCP server over HTTP. include::streaming:reference:partial$rpk-cloud/rpk-cloud-mcp-proxy.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc index 817724f86..f97dad01c 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp-stdio.adoc @@ -1,3 +1,4 @@ = rpk cloud mcp stdio +:description: Communicate with the local MCP server for Redpanda Cloud using the stdio protocol. This command provides a direct stdio interface for communicating with the local MCP server for Redpanda Cloud. include::streaming:reference:partial$rpk-cloud/rpk-cloud-mcp-stdio.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp.adoc index 6ba0878a1..9c814231d 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud-mcp.adoc @@ -1,3 +1,4 @@ = rpk cloud mcp +:description: Manage Redpanda Cloud MCP server. include::streaming:reference:partial$rpk-cloud/rpk-cloud-mcp.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud.adoc b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud.adoc index c7310b76a..0410e8b1b 100644 --- a/modules/reference/pages/rpk/rpk-cloud/rpk-cloud.adoc +++ b/modules/reference/pages/rpk/rpk-cloud/rpk-cloud.adoc @@ -1,4 +1,5 @@ = rpk cloud :page-aliases: reference:rpk/rpk-cloud.adoc +:description: Interact with Redpanda Cloud. include::streaming:reference:partial$rpk-cloud/rpk-cloud.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc index 16ece95bc..284f51468 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc @@ -1,3 +1,4 @@ = rpk cluster config get +:description: Get a cluster configuration property. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-config-get.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc index d41f2d7b9..2b4d0051a 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc @@ -1,3 +1,4 @@ = rpk cluster config list +:description: List cluster configuration properties. This command lists all available cluster configuration properties. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-config-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc index 9c35c9a06..15be95251 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc @@ -1,3 +1,4 @@ = rpk cluster config set +:description: Set a single cluster configuration property. This command is provided for use in scripts. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-config-set.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc index 9ec5c30e4..bc7e39e5e 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc @@ -1,3 +1,4 @@ = rpk cluster config status +:description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-config-status.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc index b07ae15c5..152632d31 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc @@ -1,3 +1,4 @@ = rpk cluster config +:description: View and modify Redpanda cluster configuration properties. Modified properties are propagated immediately to all brokers. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-config.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections-list.adoc index 2c8c0700e..15a40df12 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections-list.adoc @@ -1,3 +1,4 @@ = rpk cluster connections list +:description: Display statistics about current Kafka connections. This command displays a table of active and recently closed connections within the cluster. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-connections-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections.adoc index 4e8e2f3f5..2e0b9da74 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-connections.adoc @@ -1,3 +1,4 @@ = rpk cluster connections +:description: Manage and monitor cluster connections. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-connections.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc index e138e49ac..e1fdfac5c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc @@ -1,4 +1,5 @@ = rpk cluster info :page-aliases: reference:rpk/rpk-cluster/rpk-cluster-metadata.adoc +:description: Request broker metadata information. The Kafka protocol's metadata contains information about brokers, topics, and the cluster as a whole. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-info.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc index 1bd0dcc23..27db3bfe6 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc @@ -1,3 +1,4 @@ = rpk cluster logdirs describe +:description: Describe log directories on Redpanda brokers. This command prints information about log directories on brokers, particularly, the base directory that topics and partitions are located in, and the size of data that has been written to the partitions. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc index 62524d401..f59aaf203 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc @@ -1,3 +1,4 @@ = rpk cluster logdirs +:description: Describe log directories on Redpanda brokers. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-logdirs.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc index 81ce1ea0f..c16383aba 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc @@ -1,3 +1,4 @@ = rpk cluster quotas alter +:description: Add or delete a client quota. This command allows you to add or delete a client quota. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc index aa723ee4c..f0ac2bae9 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc @@ -1,3 +1,4 @@ = rpk cluster quotas describe +:description: Describe client quotas. This command describes client quotas that match the provided filtering criteria. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc index fb3a92e69..39ab2b832 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc @@ -1,3 +1,4 @@ = rpk cluster quotas import +:description: pass:q[Use this command to import client quotas in the format produced by `rpk cluster quotas describe --format json/yaml`.] include::streaming:reference:rpk/rpk-cluster/rpk-cluster-quotas-import.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc index 7abeb491d..b1479e9be 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc @@ -1,3 +1,4 @@ = rpk cluster quotas +:description: Manage Redpanda client quotas. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-quotas.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc index f4cb852e5..96ddff566 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc @@ -1,3 +1,4 @@ = rpk cluster storage cancel mount +:description: Cancels a mount/unmount operation on a topic. Use the migration ID that is emitted when the mount or unmount operation is executed. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc index 51eb23ba4..3f4bb16d4 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc @@ -1,3 +1,4 @@ = rpk cluster storage list mount +:description: pass:q[List mount/unmount operations on a topic to the Redpanda cluster from Tiered Storage. You can also filter the list by state using the `--filter` flag.] include::streaming:reference:rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc index 3d047c2fc..91056aa88 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc @@ -1,3 +1,4 @@ = rpk cluster storage list-mountable +:description: List topics that are available to mount from object storage. This command displays topics that exist in object storage and can be mounted to your Redpanda cluster. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc index c57c0cf80..ff41c1c7c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc @@ -1,3 +1,4 @@ = rpk cluster storage mount +:description: Mount a topic to the Redpanda cluster from Tiered Storage. This command mounts a topic in the Redpanda cluster using log segments stored in Tiered Storage. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-storage-mount.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc index d79398778..1f495b2d7 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc @@ -1,3 +1,4 @@ = rpk cluster storage status mount +:description: Check the status of a mount or unmount operation for a topic in Tiered Storage. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc index b1b30f1a0..bbccd0c35 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc @@ -1,3 +1,4 @@ = rpk cluster storage unmount +:description: Unmount a topic from the Redpanda cluster and secure it in Tiered Storage. This command performs an operation that: 1. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc index e1e13f57c..4828fe1d3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc @@ -1,3 +1,4 @@ = rpk cluster storage +:description: Manage cluster storage, including mounting and unmounting topics from Tiered Storage. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-storage.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc index 25c10b388..93cf318ba 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc @@ -1,3 +1,4 @@ = rpk cluster txn describe-producers +:description: Describe transactional producers to partitions. This command describes partitions that active transactional producers are producing to. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe.adoc index 36cf657d4..3d938276b 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-describe.adoc @@ -1,3 +1,4 @@ = rpk cluster txn describe +:description: pass:q[Describe transactional IDs. This command, in comparison to `list`, is a more detailed per-transaction view of transactional IDs.] include::streaming:reference:rpk/rpk-cluster/rpk-cluster-txn-describe.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc index 069c5d3cd..29f635ac6 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc @@ -1,3 +1,4 @@ = rpk cluster txn list +:description: List transactions and their current states. This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-txn-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc index 98a048b0d..b43e906b0 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc @@ -1,3 +1,4 @@ = rpk cluster txn +:description: Information about transactions and transactional producers. Transactions allow producing, or consume-modifying-producing, to Redpanda. include::streaming:reference:rpk/rpk-cluster/rpk-cluster-txn.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc index 310c05dcd..858e993db 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc @@ -1,3 +1,4 @@ = rpk cluster +:description: Manage and inspect Redpanda cluster configuration, health, and maintenance operations. include::streaming:reference:rpk/rpk-cluster/rpk-cluster.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-commands.adoc b/modules/reference/pages/rpk/rpk-commands.adoc index c95143eeb..bb6be8739 100644 --- a/modules/reference/pages/rpk/rpk-commands.adoc +++ b/modules/reference/pages/rpk/rpk-commands.adoc @@ -1,4 +1,5 @@ = rpk :page-aliases: reference:rpk-commands.adoc +:description: pass:q[The `rpk` is Redpanda's command line interface (CLI) utility.] include::streaming:reference:rpk/rpk-commands.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc index 1268ce22c..826b9d819 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc @@ -1,4 +1,5 @@ = rpk generate app :page-aliases: reference:rpk/rpk-generate.adoc +:description: Generate a sample application to connect with Redpanda. This command generates a starter application to produce and consume from the settings defined in the rpk profile. include::streaming:reference:rpk/rpk-generate/rpk-generate-app.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc index 7d4aa5300..210830549 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc @@ -1,3 +1,4 @@ = rpk generate grafana-dashboard +:description: Generate Grafana Dashboards for Redpanda Metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics. include::streaming:reference:rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-shell-completion.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-shell-completion.adoc index b8be4801d..89f9f8eb1 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-shell-completion.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-shell-completion.adoc @@ -1,3 +1,4 @@ = rpk generate shell-completion +:description: pass:q[Shell completion can help autocomplete `rpk` commands when you press tab.] include::streaming:reference:rpk/rpk-generate/rpk-generate-shell-completion.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc index de33494da..043a09397 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc @@ -1,3 +1,4 @@ = rpk generate +:description: Generate a configuration template for related services. include::streaming:reference:rpk/rpk-generate/rpk-generate.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc index 1a1302201..b98af2833 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc @@ -1,3 +1,4 @@ = rpk group delete +:description: Delete one or more consumer groups. You may want to delete groups to clean up committed offsets sooner than they expire automatically, such as when you create temporary groups for quick investigation or testing. include::streaming:reference:rpk/rpk-group/rpk-group-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc index 9b8a2a4ea..5460fbdd5 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc @@ -1,3 +1,4 @@ = rpk group describe +:description: Describe group offset status & lag. This command describes group members, calculates their lag, and prints detailed information about the members. include::streaming:reference:rpk/rpk-group/rpk-group-describe.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc index 9e55ee39a..35764fa3f 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc @@ -1,3 +1,4 @@ = rpk group list +:description: List all groups. This command lists all groups currently known to Redpanda, including empty groups that have not yet expired. include::streaming:reference:rpk/rpk-group/rpk-group-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc index 11b084077..5b4d15dfc 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc @@ -1,3 +1,4 @@ = rpk group offset-delete +:description: Forcefully delete offsets for a kafka group. The broker will only allow the request to succeed if the group is in a dead state (no subscriptions) or there are no subscriptions for offsets for topic/partitions requested to be deleted. include::streaming:reference:rpk/rpk-group/rpk-group-offset-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc index 6aab27e02..6aeab01f6 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc @@ -1,3 +1,4 @@ = rpk group seek +:description: Modify a group's current offsets. This command allows you to modify a group's offsets. include::streaming:reference:rpk/rpk-group/rpk-group-seek.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group.adoc index e6ca585a9..821a50a46 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group.adoc @@ -1,3 +1,4 @@ = rpk group +:description: Describe, list, and delete consumer groups and manage their offsets. Consumer groups allow you to horizontally scale consuming from topics. include::streaming:reference:rpk/rpk-group/rpk-group.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-help.adoc b/modules/reference/pages/rpk/rpk-help.adoc index 229f76635..169aeee64 100644 --- a/modules/reference/pages/rpk/rpk-help.adoc +++ b/modules/reference/pages/rpk/rpk-help.adoc @@ -1,3 +1,4 @@ = rpk help +:description: pass:q[Help provides help for any command in the application. Simply type `rpk help` [path to command] for full details.] include::streaming:reference:rpk/rpk-help.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-install.adoc b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-install.adoc index 7b44f698c..f8547ffeb 100644 --- a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-install.adoc +++ b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-install.adoc @@ -1,3 +1,4 @@ = rpk plugin install +:description: pass:q[Install an `rpk plugin`. An `rpk` plugin must be saved in `$HOME/.local/bin` or in a directory that is in your `$PATH`.] include::streaming:reference:rpk/rpk-plugin/rpk-plugin-install.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc index 307de8364..289a61ae9 100644 --- a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc +++ b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc @@ -1,3 +1,4 @@ = rpk plugin list +:description: List all available plugins. By default, this command fetches the remote manifest and prints plugins available for download. include::streaming:reference:rpk/rpk-plugin/rpk-plugin-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-uninstall.adoc b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-uninstall.adoc index eb6e1aa82..79fcb5309 100644 --- a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-uninstall.adoc +++ b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-uninstall.adoc @@ -1,3 +1,4 @@ = rpk plugin uninstall +:description: Uninstall / remove an existing local plugin. This command lists locally installed plugins and removes the first plugin that matches the requested removal. include::streaming:reference:rpk/rpk-plugin/rpk-plugin-uninstall.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin.adoc b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin.adoc index 1e452b804..5eb47e475 100644 --- a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin.adoc +++ b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin.adoc @@ -1,4 +1,5 @@ = rpk plugin :page-aliases: reference:rpk/rpk-plugin.adoc +:description: pass:q[List, download, update, and remove `rpk` plugins. Plugins augment `rpk` with new commands.] include::streaming:reference:rpk/rpk-plugin/rpk-plugin.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-clear.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-clear.adoc index 969bc2065..b1e90b1c1 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-clear.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-clear.adoc @@ -1,3 +1,4 @@ = rpk profile clear +:description: Clear the current profile. This command clears the current profile, which can be useful to unset a production cluster profile. include::streaming:reference:rpk/rpk-profile/rpk-profile-clear.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-create.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-create.adoc index 1ce2a6180..a5ed2b0e8 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-create.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-create.adoc @@ -1,3 +1,4 @@ = rpk profile create +:description: pass:q[Create a new `rpk` profile with connection settings for a Redpanda cluster. There are multiple ways to create a profile.] include::streaming:reference:rpk/rpk-profile/rpk-profile-create.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-current.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-current.adoc index a78363796..b5dcaa30b 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-current.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-current.adoc @@ -1,3 +1,4 @@ = rpk profile current +:description: Print the current profile name. This is a tiny command that simply prints the current profile name, which may be useful in scripts, or a PS1, or to confirm what you have selected. include::streaming:reference:rpk/rpk-profile/rpk-profile-current.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-delete.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-delete.adoc index 14de0304b..2a6e4e1c0 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-delete.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-delete.adoc @@ -1,3 +1,4 @@ = rpk profile delete +:description: pass:q[Delete an rpk profile. Deleting a profile removes it from the `rpk.yaml` file.] include::streaming:reference:rpk/rpk-profile/rpk-profile-delete.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit-globals.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit-globals.adoc index f5ad3dfe4..d42d5a880 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit-globals.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit-globals.adoc @@ -1,3 +1,4 @@ = rpk profile edit-globals +:description: pass:q[Edit `rpk` globals. This command opens your default editor to edit the `rpk` global configurations.] include::streaming:reference:rpk/rpk-profile/rpk-profile-edit-globals.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc index 4fbd62ba7..2b64b637a 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-edit.adoc @@ -1,3 +1,4 @@ = rpk profile edit +:description: Edit an rpk profile. This command opens your default editor to edit the specified profile, or the current profile if no profile is specified. include::streaming:reference:rpk/rpk-profile/rpk-profile-edit.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc index 818b10a12..07b95ef6b 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc @@ -1,3 +1,4 @@ = rpk profile list +:description: pass:q[List `rpk` profiles.] include::streaming:reference:rpk/rpk-profile/rpk-profile-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-print-globals.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-print-globals.adoc index a5705c1e2..733b7df40 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-print-globals.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-print-globals.adoc @@ -1,3 +1,4 @@ = rpk profile print-globals +:description: pass:q[Print `rpk` global configuration.] include::streaming:reference:rpk/rpk-profile/rpk-profile-print-globals.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-print.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-print.adoc index 95cb76713..a831e34a4 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-print.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-print.adoc @@ -1,3 +1,4 @@ = rpk profile print +:description: pass:q[Print `rpk` profile configuration. If no name is specified, this command prints the current profile as it exists in the `rpk.yaml` file.] include::streaming:reference:rpk/rpk-profile/rpk-profile-print.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc index eeace52cf..d048ef41a 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc @@ -1,3 +1,4 @@ = rpk profile prompt +:description: pass:q[Prompt a profile name formatted for a PS1 prompt. This command prints ANSI-escaped text per your current profile's `prompt` field.] include::streaming:reference:rpk/rpk-profile/rpk-profile-prompt.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-rename-to.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-rename-to.adoc index 1c8876f38..62333a8cb 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-rename-to.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-rename-to.adoc @@ -1,3 +1,4 @@ = rpk profile rename-to +:description: pass:q[Rename the current `rpk profile`. This command renames the currently active profile to the specified name.] include::streaming:reference:rpk/rpk-profile/rpk-profile-rename-to.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set-globals.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set-globals.adoc index 53594fb16..90fa5f9a0 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set-globals.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set-globals.adoc @@ -1,3 +1,4 @@ = rpk profile set-globals +:description: pass:q[Set `rpk` globals fields. This command takes a list of key=value pairs to write to the global config section of `rpk.yaml`.] include::streaming:reference:rpk/rpk-profile/rpk-profile-set-globals.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc index 0535391ca..77950622d 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc @@ -1,3 +1,4 @@ = rpk profile set +:description: pass:q[Set fields in the current `rpk profile`. As in the create command, this command takes a list of key=value pairs to write to the current profile.] include::streaming:reference:rpk/rpk-profile/rpk-profile-set.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-use.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-use.adoc index 3d9992b0a..3c824a715 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-use.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-use.adoc @@ -1,3 +1,4 @@ = rpk profile use +:description: pass:q[Switch to a different `rpk profile`, making it the active profile for subsequent `rpk` commands.] include::streaming:reference:rpk/rpk-profile/rpk-profile-use.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc index 391019faf..5c4cbec4d 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc @@ -1,4 +1,5 @@ = rpk profile :page-aliases: reference:rpk/rpk-profile.adoc +:description: pass:q[Manage `rpk` profiles. An rpk profile talks to a single Redpanda cluster.] include::streaming:reference:rpk/rpk-profile/rpk-profile.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc index dd2d64a0b..609892ff1 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc @@ -1,3 +1,4 @@ = rpk registry compatibility-level get +:description: pass:q[Get the global or per-subject compatibility levels. Running this command with no subject returns the global level, alternatively you can use the `--global` flag to get the global level at the same time as per-subject levels.] include::streaming:reference:rpk/rpk-registry/rpk-registry-compatibility-level-get.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc index 8f9492548..c210fedca 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc @@ -1,3 +1,4 @@ = rpk registry compatibility-level set +:description: Set the global or per-subject compatibility levels. Running this command without a subject sets the global compatibility level. include::streaming:reference:rpk/rpk-registry/rpk-registry-compatibility-level-set.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level.adoc index 58ecfc19b..8eef8f3d0 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-compatibility-level.adoc @@ -1,3 +1,4 @@ = rpk registry compatibility-level +:description: Manage global or per-subject compatibility levels. include::streaming:reference:rpk/rpk-registry/rpk-registry-compatibility-level.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-context-delete.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-context-delete.adoc index 15d113ad1..ca42d61b1 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-context-delete.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-context-delete.adoc @@ -1,3 +1,4 @@ = rpk registry context delete +:description: Delete a schema registry context. A context can only be deleted once all subjects within it have been hard deleted. include::streaming:reference:rpk/rpk-registry/rpk-registry-context-delete.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-context-list.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-context-list.adoc index a24302519..35d00c684 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-context-list.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-context-list.adoc @@ -1,3 +1,4 @@ = rpk registry context list +:description: List schema registry contexts. include::streaming:reference:rpk/rpk-registry/rpk-registry-context-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-context.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-context.adoc index e923d3be0..31442b645 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-context.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-context.adoc @@ -1,3 +1,4 @@ = rpk registry context +:description: Manage schema registry contexts. Schema contexts provide namespace isolation within the schema registry, allowing multiple independent sets of subjects and schemas to coexist. include::streaming:reference:rpk/rpk-registry/rpk-registry-context.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-get.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-get.adoc index d1edb9b83..3c898e592 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-get.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-get.adoc @@ -1,3 +1,4 @@ = rpk registry mode get +:description: Get schema registry mode. Running this command with no subject returns the global mode. include::streaming:reference:rpk/rpk-registry/rpk-registry-mode-get.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-reset.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-reset.adoc index 66812e695..1302e2c79 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-reset.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-reset.adoc @@ -1,3 +1,4 @@ = rpk registry mode reset +:description: Reset schema registry mode. This command deletes any subject modes and reverts to the global default. include::streaming:reference:rpk/rpk-registry/rpk-registry-mode-reset.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc index 6a439baf1..ea8032e93 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc @@ -1,3 +1,4 @@ = rpk registry mode set +:description: pass:q[Set schema registry mode. Running this command with no subject sets the global schema registry mode, alternatively you can use the `--global` flag to set the global schema registry mode at the same time as per-subject mode.] include::streaming:reference:rpk/rpk-registry/rpk-registry-mode-set.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc index d7af44e39..3487e5487 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc @@ -1,3 +1,4 @@ = rpk registry mode +:description: Manage schema registry mode. include::streaming:reference:rpk/rpk-registry/rpk-registry-mode.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc index a8918ab2d..0b015cde3 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc @@ -1,3 +1,4 @@ = rpk registry schema check-compatibility +:description: Check schema compatibility with existing schemas in the subject. include::streaming:reference:rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc index 891fd8d18..dc25e860b 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc @@ -1,3 +1,4 @@ = rpk registry schema create +:description: Create a schema for the given subject. This uploads a schema to the registry, creating the schema if it does not exist. include::streaming:reference:rpk/rpk-registry/rpk-registry-schema-create.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-delete.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-delete.adoc index 3868ec5fe..9c8493a69 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-delete.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-delete.adoc @@ -1,3 +1,4 @@ = rpk registry schema delete +:description: pass:q[Delete a specific schema for the given subject. By default, schemas are soft deleted and can still be retrieved with the `--deleted` flag on other commands.] include::streaming:reference:rpk/rpk-registry/rpk-registry-schema-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc index 65e757f55..9c26a1433 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc @@ -1,3 +1,4 @@ = rpk registry schema get +:description: Get a schema by version, ID, or by an existing schema. This returns a lookup of an existing schema or schemas in one of a few potential (mutually exclusive) ways: * By version, returning a schema for a required subject and version. include::streaming:reference:rpk/rpk-registry/rpk-registry-schema-get.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-list.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-list.adoc index cf04376d6..d73caf1a0 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-list.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-list.adoc @@ -1,3 +1,4 @@ = rpk registry schema list +:description: List the schemas for the requested subjects, or list all schemas. include::streaming:reference:rpk/rpk-registry/rpk-registry-schema-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-references.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-references.adoc index 6563fe044..346eaadbf 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-references.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-references.adoc @@ -1,3 +1,4 @@ = rpk registry schema references +:description: Retrieve a list of schemas that reference the subject. include::streaming:reference:rpk/rpk-registry/rpk-registry-schema-references.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc index e8c5fa5b8..15076d59d 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc @@ -1,3 +1,4 @@ = rpk registry schema +:description: Manage your schema registry schemas. include::streaming:reference:rpk/rpk-registry/rpk-registry-schema.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-delete.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-delete.adoc index 351fb56f6..eeee36e42 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-delete.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-delete.adoc @@ -1,3 +1,4 @@ = rpk registry subject delete +:description: Delete one or more schema registry subjects. By default, subjects are soft deleted. include::streaming:reference:rpk/rpk-registry/rpk-registry-subject-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-list.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-list.adoc index 749c96c4f..b1aa5b2ca 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-list.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject-list.adoc @@ -1,3 +1,4 @@ = rpk registry subject list +:description: Display all subjects. include::streaming:reference:rpk/rpk-registry/rpk-registry-subject-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject.adoc index c2d804384..dc87afe01 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-subject.adoc @@ -1,3 +1,4 @@ = rpk registry subject +:description: List or delete schema registry subjects. include::streaming:reference:rpk/rpk-registry/rpk-registry-subject.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry.adoc index eea2944fe..209611b4f 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry.adoc @@ -1,3 +1,4 @@ = rpk registry +:description: Commands to interact with the schema registry. include::streaming:reference:rpk/rpk-registry/rpk-registry.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc index 3adb35410..0668880a4 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc @@ -1,4 +1,5 @@ = rpk security acl create :page-aliases: reference:rpk/rpk-acl/rpk-acl-create.adoc +:description: Create ACLs. Following the multiplying effect of combining flags, the create command works on a straightforward basis: every ACL combination is a created ACL. include::streaming:reference:rpk/rpk-security/rpk-security-acl-create.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc index 0d9ec074f..d0face19e 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc @@ -1,4 +1,5 @@ = rpk security acl delete :page-aliases: reference:rpk/rpk-acl/rpk-acl-delete.adoc +:description: pass:q[Delete ACLs. See the `rpk security acl` help text for a full write up on ACLs.] include::streaming:reference:rpk/rpk-security/rpk-security-acl-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc index bc10d64dd..43394574e 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-list.adoc @@ -1,4 +1,5 @@ = rpk security acl list :page-aliases: reference:rpk/rpk-acl/rpk-acl-list.adoc +:description: pass:q[List ACLs. See the `rpk security acl` help text for a full write up on ACLs.] include::streaming:reference:rpk/rpk-security/rpk-security-acl-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc index 0bdb54abc..4bdf945b7 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc @@ -1,4 +1,5 @@ = rpk security acl :page-aliases: reference:rpk/rpk-acl.adoc, reference:rpk/rpk-acl/rpk-acl.adoc +:description: Manage ACLs and SASL users. This command space creates, lists, and deletes ACLs, as well as creates SASL users. include::streaming:reference:rpk/rpk-security/rpk-security-acl.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adoc index e348e03d2..8949069db 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-assign.adoc @@ -1,3 +1,4 @@ = rpk security role assign +:description: pass:q[Assign a Redpanda role to a principal. The `--principal` flag accepts principals with the format ':'.] include::streaming:reference:rpk/rpk-security/rpk-security-role-assign.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-create.adoc index cd9bceb46..afac9b13a 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-create.adoc @@ -1,3 +1,4 @@ = rpk security role create +:description: pass:q[Create a role in Redpanda. After creating a role you may bind ACLs to the role using the `--allow-role` flag in the `rpk security acl create` command.] include::streaming:reference:rpk/rpk-security/rpk-security-role-create.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-delete.adoc index e14ca2de1..b8fb3b704 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-delete.adoc @@ -1,3 +1,4 @@ = rpk security role delete +:description: Delete a role in Redpanda. This action will remove all associated ACLs from the role and unassign members. include::streaming:reference:rpk/rpk-security/rpk-security-role-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-describe.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-describe.adoc index 3d681cf6f..7872b62c1 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-describe.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-describe.adoc @@ -1,3 +1,4 @@ = rpk security role describe +:description: Describe a Redpanda role. This command describes a role, including the ACLs associated to the role, and lists members who are assigned the role. include::streaming:reference:rpk/rpk-security/rpk-security-role-describe.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-list.adoc index 75d997cf2..8626d8531 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-list.adoc @@ -1,3 +1,4 @@ = rpk security role list +:description: List roles created in Redpanda. include::streaming:reference:rpk/rpk-security/rpk-security-role-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adoc index 8b861c7e3..6b99efad8 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role-unassign.adoc @@ -1,3 +1,4 @@ = rpk security role unassign +:description: pass:q[Unassign a Redpanda role from a principal. The `--principal` flag accepts principals with the format ':'.] include::streaming:reference:rpk/rpk-security/rpk-security-role-unassign.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-role.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-role.adoc index d7a19c647..4d154c4ed 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-role.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-role.adoc @@ -1,3 +1,4 @@ = rpk security role +:description: Manage Redpanda roles. include::streaming:reference:rpk/rpk-security/rpk-security-role.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc index 731984633..62e3fb1b1 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-create.adoc @@ -1,3 +1,4 @@ = rpk security secret create +:description: Create a new secret for your Redpanda Cloud cluster. Scopes define the areas where the secret can be used. include::streaming:reference:partial$rpk-security/rpk-security-secret-create.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc index 6b55186f8..b430ac938 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-delete.adoc @@ -1,3 +1,4 @@ = rpk security secret delete +:description: Delete an existing secret from your Redpanda Cloud cluster. include::streaming:reference:partial$rpk-security/rpk-security-secret-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc index 3ca4d8cd8..7658d4d7f 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-list.adoc @@ -1,3 +1,4 @@ = rpk security secret list +:description: List all secrets in your Redpanda Cloud cluster. include::streaming:reference:partial$rpk-security/rpk-security-secret-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc index 9ff3cb0a6..0caaaa2f6 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret-update.adoc @@ -1,3 +1,4 @@ = rpk security secret update +:description: Update an existing secret for your Redpanda Cloud cluster. Scopes define the areas where the secret can be used. include::streaming:reference:partial$rpk-security/rpk-security-secret-update.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc index deb73333d..c5ae9f606 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-secret.adoc @@ -1,3 +1,4 @@ = rpk security secret +:description: Manage secrets for Redpanda Cloud clusters. This command allows you to manage secrets for your cloud clusters. include::streaming:reference:partial$rpk-security/rpk-security-secret.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc index 607b924d9..942eba558 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-create.adoc @@ -1,4 +1,5 @@ = rpk security user create :page-aliases: reference:rpk/rpk-acl/rpk-acl-user-create.adoc, reference:rpk/rpk-security/rpk-security-acl-user-create.adoc +:description: pass:q[Create a SASL user. This command creates a single SASL user with the given password, optionally with a custom `mechanism`.] include::streaming:reference:rpk/rpk-security/rpk-security-user-create.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc index 1800dbecc..f56d2a25a 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-delete.adoc @@ -1,4 +1,5 @@ = rpk security user delete :page-aliases: reference:rpk/rpk-acl/rpk-acl-user-delete.adoc, reference:rpk/rpk-security/rpk-security-acl-user-delete.adoc +:description: Delete a SASL user. This command deletes the specified SASL account from Redpanda. include::streaming:reference:rpk/rpk-security/rpk-security-user-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc index c0a372dac..02772e56c 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-list.adoc @@ -1,4 +1,5 @@ = rpk security user list :page-aliases: reference:rpk/rpk-acl/rpk-acl-user-list.adoc, reference:rpk/rpk-security/rpk-security-acl-user-list.adoc +:description: List SASL users. include::streaming:reference:rpk/rpk-security/rpk-security-user-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc index 7b0816d93..fb51f1d1f 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user-update.adoc @@ -1,4 +1,5 @@ = rpk security user update :page-aliases: reference:rpk/rpk-acl/rpk-acl-user-update.adoc, reference:rpk/rpk-security/rpk-security-acl-user-update.adoc +:description: Update SASL user credentials. include::streaming:reference:rpk/rpk-security/rpk-security-user-update.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc index efbc0e572..245465904 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-user.adoc @@ -1,4 +1,5 @@ = rpk security user :page-aliases: reference:rpk/rpk-acl/rpk-acl-user.adoc, reference:rpk/rpk-security/rpk-security-acl-user.adoc +:description: Manage SASL users. If SASL is enabled, a SASL user is what you use to talk to Redpanda, and ACLs control what your user has access to. include::streaming:reference:rpk/rpk-security/rpk-security-user.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security.adoc index 9c489be3f..8630912ba 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security.adoc @@ -1,3 +1,4 @@ = rpk security +:description: Manage Redpanda security. include::streaming:reference:rpk/rpk-security/rpk-security.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc index 4fa04ab39..b21b60f6a 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc @@ -1,3 +1,4 @@ = rpk shadow config generate +:description: Generate a configuration file for creating a Shadow Link. By default, this command creates a sample configuration file with placeholder values that you can customize for your environment. include::streaming:reference:rpk/rpk-shadow/rpk-shadow-config-generate.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc index ec1bd0e5c..89846ff89 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc @@ -1,3 +1,4 @@ = rpk shadow create +:description: Create a Redpanda Shadow Link. This command creates a Shadow Link using a configuration file that defines the connection details and synchronization settings. include::streaming:reference:rpk/rpk-shadow/rpk-shadow-create.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc index fdf92aec4..cac748f2a 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc @@ -1,3 +1,4 @@ = rpk shadow delete +:description: Delete a Redpanda Shadow Link. This command deletes a Shadow Link by name. include::streaming:reference:rpk/rpk-shadow/rpk-shadow-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc index c58226d12..8f03e1248 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc @@ -1,3 +1,4 @@ = rpk shadow describe +:description: pass:q[Describe one or more shadow links. For Redpanda Cloud, `rpk` uses the Redpanda ID of the cluster you are currently logged in to.] include::streaming:reference:rpk/rpk-shadow/rpk-shadow-describe.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc index 7ca20c0fd..36ba77a9a 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc @@ -1,3 +1,4 @@ = rpk shadow failover +:description: Failover a Redpanda Shadow Link. This command performs a failover operation for a Shadow Link. include::streaming:reference:rpk/rpk-shadow/rpk-shadow-failover.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc index b3833c451..25d364caf 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc @@ -1,3 +1,4 @@ = rpk shadow list +:description: List Redpanda Shadow Links. This command lists all Shadow Links on the shadow cluster, showing their names, unique identifiers, and current states. include::streaming:reference:rpk/rpk-shadow/rpk-shadow-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc index 3d541ec64..c38d48c3f 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc @@ -1,3 +1,4 @@ = rpk shadow status +:description: Get the status of a Redpanda Shadow Link. This command shows the current status of a Shadow Link, including the overall state, task statuses, and per-topic replication progress. include::streaming:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc index eeabe9269..6d1f7559c 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc @@ -1,3 +1,4 @@ = rpk shadow update +:description: Update a Shadow Link. This command opens your default editor with the current Shadow Link configuration. include::streaming:reference:rpk/rpk-shadow/rpk-shadow-update.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc index aefb90590..016d5e30c 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc @@ -1,3 +1,4 @@ = rpk shadow +:description: Manage Redpanda Shadow Links. Shadowing is Redpanda's enterprise-grade disaster recovery solution that establishes asynchronous, offset-preserving replication between two distinct Redpanda clusters. include::streaming:reference:rpk/rpk-shadow/rpk-shadow.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc index e6783165f..ec1768ee4 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc @@ -1,3 +1,4 @@ = rpk topic add-partitions +:description: Add partitions to existing topics. include::streaming:reference:rpk/rpk-topic/rpk-topic-add-partitions.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc index d5f5effb2..bd59eb46e 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc @@ -1,3 +1,4 @@ = rpk topic alter-config +:description: Set, delete, add, and remove key/value configs for a topic. This command allows you to incrementally alter the configuration for multiple topics at a time. include::streaming:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc index 02d3e31f2..a9bba0eb5 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc @@ -1,3 +1,4 @@ = rpk topic consume +:description: pass:q[Consume records from topics. Consuming records reads from any amount of input topics, formats each record according to `--format`, and prints them to `STDOUT`.] include::streaming:reference:rpk/rpk-topic/rpk-topic-consume.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc index 2bc834104..c9fe2ca16 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc @@ -1,3 +1,4 @@ = rpk topic create +:description: Create one or more Kafka topics with configurable partitions, replication factor, and topic-level settings. All topics created with one invocation have the same number of partitions, replication factor, and key/value configs. include::streaming:reference:rpk/rpk-topic/rpk-topic-create.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc index ab5de5e89..2519c1f5b 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc @@ -1,3 +1,4 @@ = rpk topic delete +:description: Delete one or more Kafka topics. This command deletes all requested topics, printing the success or fail status per topic. include::streaming:reference:rpk/rpk-topic/rpk-topic-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe.adoc index d99311315..3d968bb5c 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe.adoc @@ -1,3 +1,4 @@ = rpk topic describe +:description: Print detailed information about topics. There are three potential views: a summary of the topic, the topic configurations, and a detailed partitions section. include::streaming:reference:rpk/rpk-topic/rpk-topic-describe.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc index 5fef6f6ba..1a4d31163 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc @@ -1,3 +1,4 @@ = rpk topic list +:description: List topics, optionally listing specific topics. This command lists all topics that you have access to by default. include::streaming:reference:rpk/rpk-topic/rpk-topic-list.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-produce.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-produce.adoc index 112f940cc..988323132 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-produce.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-produce.adoc @@ -1,3 +1,4 @@ = rpk topic produce +:description: pass:q[Produce records to a topic. Producing records reads from `STDIN`, parses input according to `--format`, and produces records to Redpanda.] include::streaming:reference:rpk/rpk-topic/rpk-topic-produce.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc index 246bd636a..6fdd32aaa 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc @@ -1,3 +1,4 @@ = rpk topic trim-prefix +:description: Trim records from topics. This command allows you to trim records from topics, to trim the topics Redpanda sets the LogStartOffset for partitions to the requested offset. include::streaming:reference:rpk/rpk-topic/rpk-topic-trim-prefix.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc index 13ce91acb..3125a856f 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc @@ -1,4 +1,5 @@ = rpk topic :page-aliases: reference:rpk/rpk-topic.adoc +:description: Manage Kafka topics, including creating, deleting, and configuring topics. Also includes commands for producing and consuming messages. include::streaming:reference:rpk/rpk-topic/rpk-topic.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-build.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-build.adoc index ee873d2d5..35031f156 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-build.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-build.adoc @@ -1,4 +1,5 @@ = rpk transform build :page-aliases: labs:data-transform/rpk-transform-build.adoc +:description: pass:q[Build a transform. This command looks in the current working directory for a `transform.yaml` file.] include::streaming:reference:rpk/rpk-transform/rpk-transform-build.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-delete.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-delete.adoc index 48ad9ebb2..ae3a63488 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-delete.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-delete.adoc @@ -1,4 +1,5 @@ = rpk transform delete :page-aliases: labs:data-transform/rpk-transform-delete.adoc +:description: Delete a data transform. include::streaming:reference:rpk/rpk-transform/rpk-transform-delete.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc index 4abcb4e14..385c8dc78 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc @@ -1,4 +1,5 @@ = rpk transform deploy :page-aliases: labs:data-transform/rpk-transform-deploy.adoc +:description: pass:q[Deploy a transform. When run in the same directory as a `transform.yaml`, this reads the configuration file, then looks for a `.wasm` file with the same name as your project.] include::streaming:reference:rpk/rpk-transform/rpk-transform-deploy.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc index 41fdc7634..934163628 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc @@ -1,4 +1,5 @@ = rpk transform init :page-aliases: labs:data-transform/rpk-transform-init.adoc +:description: Initialize a new data transform project. Creates a new directory with the required project files. include::streaming:reference:rpk/rpk-transform/rpk-transform-init.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-list.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-list.adoc index fa4c5ad58..82141d86a 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-list.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-list.adoc @@ -1,4 +1,5 @@ = rpk transform list :page-aliases: labs:data-transform/rpk-transform-list.adoc +:description: pass:q[List data transforms. This command lists all data transforms in a cluster, as well as showing the state of a individual transform processor, such as if it's errored or how many records are pending to be processed (`lag`).] include::streaming:reference:rpk/rpk-transform/rpk-transform-list.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc index 0043d03a4..8dbf34f69 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc @@ -1,3 +1,4 @@ = rpk transform logs +:description: pass:q[View logs for a transform. Data transform's STDOUT and STDERR are captured during runtime and written to an internally managed topic `_redpanda.transform_logs`.] include::streaming:reference:rpk/rpk-transform/rpk-transform-logs.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc index 9fe81091d..1b4af993e 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc @@ -1,4 +1,5 @@ = rpk transform :page-aliases: labs:data-transform/rpk-transform.adoc +:description: Develop, build, deploy, and manage WebAssembly (Wasm) data transforms for Redpanda. include::streaming:reference:rpk/rpk-transform/rpk-transform.adoc[tag=single-source] diff --git a/modules/reference/pages/rpk/rpk-version.adoc b/modules/reference/pages/rpk/rpk-version.adoc index e6ac0669a..c602aa72a 100644 --- a/modules/reference/pages/rpk/rpk-version.adoc +++ b/modules/reference/pages/rpk/rpk-version.adoc @@ -1,3 +1,4 @@ = rpk version +:description: pass:q[Prints the current `rpk` and Redpanda version. This command prints the current `rpk` version and allows you to list the Redpanda version running on each node in your cluster.] include::streaming:reference:rpk/rpk-version.adoc[tag=single-source] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-x-options.adoc b/modules/reference/pages/rpk/rpk-x-options.adoc index 6d99b075b..4498842c9 100644 --- a/modules/reference/pages/rpk/rpk-x-options.adoc +++ b/modules/reference/pages/rpk/rpk-x-options.adoc @@ -1,3 +1,4 @@ = rpk -X +:description: pass:q[This command lets you override `rpk` configuration options.] include::streaming:reference:rpk/rpk-x-options.adoc[tag=single-source] \ No newline at end of file From 94ad80d8e347e50438bdc240dec80de446cd55f1 Mon Sep 17 00:00:00 2001 From: micheleRP Date: Tue, 4 Aug 2026 16:04:22 -0600 Subject: [PATCH 2/2] ci: require :description: on every page, with an upstream-gap allowlist Adds hand-written descriptions for the three remaining non-stub pages (glossary and two index pages). The lint fails any page missing a :description: unless it is listed in .github/description-allowlist.txt, which tracks the 234 connect stubs whose rp-connect-docs upstream has no description yet; a non-blocking hygiene step flags allowlist entries that gain one. Over-155-char descriptions warn on changed files only. Co-Authored-By: Claude Fable 5 --- .github/description-allowlist.txt | 239 ++++++++++++++++++ .github/workflows/lint-metadata.yml | 60 +++++ .../pages/connect/cookbooks/index.adoc | 3 +- .../develop/pages/connect/guides/index.adoc | 3 +- modules/reference/pages/glossary.adoc | 1 + 5 files changed, 304 insertions(+), 2 deletions(-) create mode 100644 .github/description-allowlist.txt create mode 100644 .github/workflows/lint-metadata.yml diff --git a/.github/description-allowlist.txt b/.github/description-allowlist.txt new file mode 100644 index 000000000..e4d532ab5 --- /dev/null +++ b/.github/description-allowlist.txt @@ -0,0 +1,239 @@ +# Pages known to lack :description: because their single-source upstream in +# rp-connect-docs has none yet. The fix is upstream: add descriptions via +# docs-data/overrides.json in rp-connect-docs, regenerate, then copy them into +# these stub headers and remove the entries here. Shrink this list; never grow it. +# lint-metadata.yml fails any page missing :description: that is not listed here. +modules/develop/pages/connect/components/buffers/about.adoc +modules/develop/pages/connect/components/buffers/memory.adoc +modules/develop/pages/connect/components/buffers/none.adoc +modules/develop/pages/connect/components/buffers/system_window.adoc +modules/develop/pages/connect/components/caches/about.adoc +modules/develop/pages/connect/components/caches/aws_dynamodb.adoc +modules/develop/pages/connect/components/caches/aws_s3.adoc +modules/develop/pages/connect/components/caches/gcp_cloud_storage.adoc +modules/develop/pages/connect/components/caches/lru.adoc +modules/develop/pages/connect/components/caches/memcached.adoc +modules/develop/pages/connect/components/caches/memory.adoc +modules/develop/pages/connect/components/caches/mongodb.adoc +modules/develop/pages/connect/components/caches/multilevel.adoc +modules/develop/pages/connect/components/caches/nats_kv.adoc +modules/develop/pages/connect/components/caches/noop.adoc +modules/develop/pages/connect/components/caches/redis.adoc +modules/develop/pages/connect/components/caches/ristretto.adoc +modules/develop/pages/connect/components/caches/sql.adoc +modules/develop/pages/connect/components/caches/ttlru.adoc +modules/develop/pages/connect/components/inputs/about.adoc +modules/develop/pages/connect/components/inputs/amqp_0_9.adoc +modules/develop/pages/connect/components/inputs/aws_kinesis.adoc +modules/develop/pages/connect/components/inputs/aws_s3.adoc +modules/develop/pages/connect/components/inputs/aws_sqs.adoc +modules/develop/pages/connect/components/inputs/azure_blob_storage.adoc +modules/develop/pages/connect/components/inputs/azure_cosmosdb.adoc +modules/develop/pages/connect/components/inputs/azure_queue_storage.adoc +modules/develop/pages/connect/components/inputs/azure_table_storage.adoc +modules/develop/pages/connect/components/inputs/batched.adoc +modules/develop/pages/connect/components/inputs/broker.adoc +modules/develop/pages/connect/components/inputs/gcp_bigquery_select.adoc +modules/develop/pages/connect/components/inputs/gcp_cloud_storage.adoc +modules/develop/pages/connect/components/inputs/gcp_pubsub.adoc +modules/develop/pages/connect/components/inputs/generate.adoc +modules/develop/pages/connect/components/inputs/git.adoc +modules/develop/pages/connect/components/inputs/http_client.adoc +modules/develop/pages/connect/components/inputs/http_server.adoc +modules/develop/pages/connect/components/inputs/inproc.adoc +modules/develop/pages/connect/components/inputs/kafka.adoc +modules/develop/pages/connect/components/inputs/kafka_franz.adoc +modules/develop/pages/connect/components/inputs/mongodb.adoc +modules/develop/pages/connect/components/inputs/mongodb_cdc.adoc +modules/develop/pages/connect/components/inputs/mqtt.adoc +modules/develop/pages/connect/components/inputs/mysql_cdc.adoc +modules/develop/pages/connect/components/inputs/nats.adoc +modules/develop/pages/connect/components/inputs/nats_jetstream.adoc +modules/develop/pages/connect/components/inputs/nats_kv.adoc +modules/develop/pages/connect/components/inputs/postgres_cdc.adoc +modules/develop/pages/connect/components/inputs/read_until.adoc +modules/develop/pages/connect/components/inputs/redis_list.adoc +modules/develop/pages/connect/components/inputs/redis_pubsub.adoc +modules/develop/pages/connect/components/inputs/redis_scan.adoc +modules/develop/pages/connect/components/inputs/redis_streams.adoc +modules/develop/pages/connect/components/inputs/redpanda.adoc +modules/develop/pages/connect/components/inputs/redpanda_common.adoc +modules/develop/pages/connect/components/inputs/redpanda_migrator.adoc +modules/develop/pages/connect/components/inputs/resource.adoc +modules/develop/pages/connect/components/inputs/schema_registry.adoc +modules/develop/pages/connect/components/inputs/sequence.adoc +modules/develop/pages/connect/components/inputs/sftp.adoc +modules/develop/pages/connect/components/inputs/slack.adoc +modules/develop/pages/connect/components/inputs/slack_users.adoc +modules/develop/pages/connect/components/inputs/spicedb_watch.adoc +modules/develop/pages/connect/components/inputs/splunk.adoc +modules/develop/pages/connect/components/inputs/sql_raw.adoc +modules/develop/pages/connect/components/inputs/sql_select.adoc +modules/develop/pages/connect/components/inputs/timeplus.adoc +modules/develop/pages/connect/components/logger/about.adoc +modules/develop/pages/connect/components/metrics/about.adoc +modules/develop/pages/connect/components/metrics/none.adoc +modules/develop/pages/connect/components/metrics/prometheus.adoc +modules/develop/pages/connect/components/outputs/about.adoc +modules/develop/pages/connect/components/outputs/amqp_0_9.adoc +modules/develop/pages/connect/components/outputs/aws_dynamodb.adoc +modules/develop/pages/connect/components/outputs/aws_kinesis.adoc +modules/develop/pages/connect/components/outputs/aws_kinesis_firehose.adoc +modules/develop/pages/connect/components/outputs/aws_s3.adoc +modules/develop/pages/connect/components/outputs/aws_sns.adoc +modules/develop/pages/connect/components/outputs/aws_sqs.adoc +modules/develop/pages/connect/components/outputs/azure_blob_storage.adoc +modules/develop/pages/connect/components/outputs/azure_cosmosdb.adoc +modules/develop/pages/connect/components/outputs/azure_data_lake_gen2.adoc +modules/develop/pages/connect/components/outputs/azure_queue_storage.adoc +modules/develop/pages/connect/components/outputs/azure_table_storage.adoc +modules/develop/pages/connect/components/outputs/broker.adoc +modules/develop/pages/connect/components/outputs/cache.adoc +modules/develop/pages/connect/components/outputs/drop_on.adoc +modules/develop/pages/connect/components/outputs/elasticsearch_v8.adoc +modules/develop/pages/connect/components/outputs/fallback.adoc +modules/develop/pages/connect/components/outputs/gcp_bigquery.adoc +modules/develop/pages/connect/components/outputs/gcp_cloud_storage.adoc +modules/develop/pages/connect/components/outputs/gcp_pubsub.adoc +modules/develop/pages/connect/components/outputs/http_client.adoc +modules/develop/pages/connect/components/outputs/inproc.adoc +modules/develop/pages/connect/components/outputs/kafka.adoc +modules/develop/pages/connect/components/outputs/kafka_franz.adoc +modules/develop/pages/connect/components/outputs/mongodb.adoc +modules/develop/pages/connect/components/outputs/mqtt.adoc +modules/develop/pages/connect/components/outputs/nats.adoc +modules/develop/pages/connect/components/outputs/nats_jetstream.adoc +modules/develop/pages/connect/components/outputs/nats_kv.adoc +modules/develop/pages/connect/components/outputs/opensearch.adoc +modules/develop/pages/connect/components/outputs/pinecone.adoc +modules/develop/pages/connect/components/outputs/qdrant.adoc +modules/develop/pages/connect/components/outputs/questdb.adoc +modules/develop/pages/connect/components/outputs/redis_hash.adoc +modules/develop/pages/connect/components/outputs/redis_list.adoc +modules/develop/pages/connect/components/outputs/redis_pubsub.adoc +modules/develop/pages/connect/components/outputs/redis_streams.adoc +modules/develop/pages/connect/components/outputs/redpanda.adoc +modules/develop/pages/connect/components/outputs/redpanda_common.adoc +modules/develop/pages/connect/components/outputs/redpanda_migrator.adoc +modules/develop/pages/connect/components/outputs/reject.adoc +modules/develop/pages/connect/components/outputs/reject_errored.adoc +modules/develop/pages/connect/components/outputs/resource.adoc +modules/develop/pages/connect/components/outputs/retry.adoc +modules/develop/pages/connect/components/outputs/schema_registry.adoc +modules/develop/pages/connect/components/outputs/sftp.adoc +modules/develop/pages/connect/components/outputs/slack_post.adoc +modules/develop/pages/connect/components/outputs/snowflake_put.adoc +modules/develop/pages/connect/components/outputs/snowflake_streaming.adoc +modules/develop/pages/connect/components/outputs/splunk_hec.adoc +modules/develop/pages/connect/components/outputs/sql_insert.adoc +modules/develop/pages/connect/components/outputs/sql_raw.adoc +modules/develop/pages/connect/components/outputs/switch.adoc +modules/develop/pages/connect/components/outputs/sync_response.adoc +modules/develop/pages/connect/components/outputs/timeplus.adoc +modules/develop/pages/connect/components/processors/about.adoc +modules/develop/pages/connect/components/processors/archive.adoc +modules/develop/pages/connect/components/processors/avro.adoc +modules/develop/pages/connect/components/processors/aws_bedrock_chat.adoc +modules/develop/pages/connect/components/processors/aws_bedrock_embeddings.adoc +modules/develop/pages/connect/components/processors/aws_dynamodb_partiql.adoc +modules/develop/pages/connect/components/processors/aws_lambda.adoc +modules/develop/pages/connect/components/processors/azure_cosmosdb.adoc +modules/develop/pages/connect/components/processors/benchmark.adoc +modules/develop/pages/connect/components/processors/bloblang.adoc +modules/develop/pages/connect/components/processors/bounds_check.adoc +modules/develop/pages/connect/components/processors/branch.adoc +modules/develop/pages/connect/components/processors/cache.adoc +modules/develop/pages/connect/components/processors/cached.adoc +modules/develop/pages/connect/components/processors/catch.adoc +modules/develop/pages/connect/components/processors/cohere_chat.adoc +modules/develop/pages/connect/components/processors/cohere_embeddings.adoc +modules/develop/pages/connect/components/processors/cohere_rerank.adoc +modules/develop/pages/connect/components/processors/compress.adoc +modules/develop/pages/connect/components/processors/decompress.adoc +modules/develop/pages/connect/components/processors/dedupe.adoc +modules/develop/pages/connect/components/processors/for_each.adoc +modules/develop/pages/connect/components/processors/gcp_bigquery_select.adoc +modules/develop/pages/connect/components/processors/gcp_vertex_ai_chat.adoc +modules/develop/pages/connect/components/processors/gcp_vertex_ai_embeddings.adoc +modules/develop/pages/connect/components/processors/google_drive_download.adoc +modules/develop/pages/connect/components/processors/google_drive_list_labels.adoc +modules/develop/pages/connect/components/processors/google_drive_search.adoc +modules/develop/pages/connect/components/processors/group_by.adoc +modules/develop/pages/connect/components/processors/group_by_value.adoc +modules/develop/pages/connect/components/processors/http.adoc +modules/develop/pages/connect/components/processors/insert_part.adoc +modules/develop/pages/connect/components/processors/jmespath.adoc +modules/develop/pages/connect/components/processors/jq.adoc +modules/develop/pages/connect/components/processors/json_schema.adoc +modules/develop/pages/connect/components/processors/log.adoc +modules/develop/pages/connect/components/processors/mapping.adoc +modules/develop/pages/connect/components/processors/metric.adoc +modules/develop/pages/connect/components/processors/mongodb.adoc +modules/develop/pages/connect/components/processors/mutation.adoc +modules/develop/pages/connect/components/processors/nats_kv.adoc +modules/develop/pages/connect/components/processors/nats_request_reply.adoc +modules/develop/pages/connect/components/processors/noop.adoc +modules/develop/pages/connect/components/processors/ollama_chat.adoc +modules/develop/pages/connect/components/processors/ollama_embeddings.adoc +modules/develop/pages/connect/components/processors/ollama_moderation.adoc +modules/develop/pages/connect/components/processors/openai_chat_completion.adoc +modules/develop/pages/connect/components/processors/openai_embeddings.adoc +modules/develop/pages/connect/components/processors/openai_image_generation.adoc +modules/develop/pages/connect/components/processors/openai_speech.adoc +modules/develop/pages/connect/components/processors/openai_transcription.adoc +modules/develop/pages/connect/components/processors/openai_translation.adoc +modules/develop/pages/connect/components/processors/parallel.adoc +modules/develop/pages/connect/components/processors/parquet_decode.adoc +modules/develop/pages/connect/components/processors/parquet_encode.adoc +modules/develop/pages/connect/components/processors/parse_log.adoc +modules/develop/pages/connect/components/processors/processors.adoc +modules/develop/pages/connect/components/processors/protobuf.adoc +modules/develop/pages/connect/components/processors/qdrant.adoc +modules/develop/pages/connect/components/processors/rate_limit.adoc +modules/develop/pages/connect/components/processors/redis.adoc +modules/develop/pages/connect/components/processors/redis_script.adoc +modules/develop/pages/connect/components/processors/resource.adoc +modules/develop/pages/connect/components/processors/retry.adoc +modules/develop/pages/connect/components/processors/schema_registry_decode.adoc +modules/develop/pages/connect/components/processors/schema_registry_encode.adoc +modules/develop/pages/connect/components/processors/select_parts.adoc +modules/develop/pages/connect/components/processors/slack_thread.adoc +modules/develop/pages/connect/components/processors/sleep.adoc +modules/develop/pages/connect/components/processors/split.adoc +modules/develop/pages/connect/components/processors/sql_insert.adoc +modules/develop/pages/connect/components/processors/sql_raw.adoc +modules/develop/pages/connect/components/processors/sql_select.adoc +modules/develop/pages/connect/components/processors/switch.adoc +modules/develop/pages/connect/components/processors/sync_response.adoc +modules/develop/pages/connect/components/processors/text_chunker.adoc +modules/develop/pages/connect/components/processors/try.adoc +modules/develop/pages/connect/components/processors/unarchive.adoc +modules/develop/pages/connect/components/processors/while.adoc +modules/develop/pages/connect/components/processors/workflow.adoc +modules/develop/pages/connect/components/processors/xml.adoc +modules/develop/pages/connect/components/rate_limits/about.adoc +modules/develop/pages/connect/components/rate_limits/local.adoc +modules/develop/pages/connect/components/rate_limits/redis.adoc +modules/develop/pages/connect/components/redpanda/about.adoc +modules/develop/pages/connect/components/scanners/about.adoc +modules/develop/pages/connect/components/scanners/avro.adoc +modules/develop/pages/connect/components/scanners/chunker.adoc +modules/develop/pages/connect/components/scanners/csv.adoc +modules/develop/pages/connect/components/scanners/decompress.adoc +modules/develop/pages/connect/components/scanners/json_documents.adoc +modules/develop/pages/connect/components/scanners/lines.adoc +modules/develop/pages/connect/components/scanners/re_match.adoc +modules/develop/pages/connect/components/scanners/skip_bom.adoc +modules/develop/pages/connect/components/scanners/switch.adoc +modules/develop/pages/connect/components/scanners/tar.adoc +modules/develop/pages/connect/components/scanners/to_the_end.adoc +modules/develop/pages/connect/components/tracers/about.adoc +modules/develop/pages/connect/components/tracers/gcp_cloudtrace.adoc +modules/develop/pages/connect/components/tracers/none.adoc +modules/develop/pages/connect/configuration/batching.adoc +modules/develop/pages/connect/configuration/error_handling.adoc +modules/develop/pages/connect/configuration/field_paths.adoc +modules/develop/pages/connect/configuration/interpolation.adoc +modules/develop/pages/connect/configuration/metadata.adoc +modules/develop/pages/connect/configuration/processing_pipelines.adoc +modules/develop/pages/connect/configuration/unit_testing.adoc diff --git a/.github/workflows/lint-metadata.yml b/.github/workflows/lint-metadata.yml new file mode 100644 index 000000000..bf7fbbd77 --- /dev/null +++ b/.github/workflows/lint-metadata.yml @@ -0,0 +1,60 @@ +name: Lint page metadata + +# Runs on every PR (no paths filter) so it can be a required status check: +# a required check that is skipped by a paths filter leaves PRs stuck pending. +# It passes fast when no pages are affected. +on: pull_request + +jobs: + descriptions: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: "Require :description: on every page" + run: | + # Style guide: every page needs a :description: (search results, link + # previews, and AI discoverability all read it). Pages listed in + # .github/description-allowlist.txt are known gaps blocked on upstream + # rp-connect-docs descriptions (docs-data/overrides.json there is the + # fix path). Everything else must carry one. Shrink the list; never + # grow it. + missing=0 + while IFS= read -r f; do + if ! grep -qE '^:description: .+' "$f"; then + if grep -qxF "$f" .github/description-allowlist.txt; then continue; fi + echo "::error file=$f::Missing :description: header attribute (and not in .github/description-allowlist.txt)" + missing=1 + fi + done < <(find modules/*/pages -name '*.adoc' -type f) + exit $missing + + - name: "Allowlist ratchet hygiene (non-blocking)" + run: | + # Allowlisted files that gained a description, or no longer exist, + # should be removed from the list. Warn only. + grep -v '^#' .github/description-allowlist.txt | while IFS= read -r f; do + [ -z "$f" ] && continue + if [ ! -f "$f" ]; then + echo "::warning::Allowlist entry no longer exists: $f - remove it from .github/description-allowlist.txt" + continue + fi + if grep -qE '^:description: .+' "$f"; then + echo "::warning file=$f::Has a description now - remove it from .github/description-allowlist.txt" + fi + done + + - name: "Warn on over-length descriptions (changed files only)" + run: | + # Style guide recommends under 155 chars (search snippet cutoff). + # Warn-only, and only for files this PR touches. + git diff --name-only "${{ github.event.pull_request.base.sha }}".."${{ github.event.pull_request.head.sha }}" \ + | grep -E '^modules/.*/pages/.*\.adoc$' | while IFS= read -r f; do + [ -f "$f" ] || continue + desc=$(grep -m1 '^:description: ' "$f" | sed 's/^:description: //') + if [ -n "$desc" ] && [ "${#desc}" -gt 155 ]; then + echo "::warning file=$f::Description is ${#desc} chars; style guide recommends under 155" + fi + done diff --git a/modules/develop/pages/connect/cookbooks/index.adoc b/modules/develop/pages/connect/cookbooks/index.adoc index 6aa8670fc..f18a0d963 100644 --- a/modules/develop/pages/connect/cookbooks/index.adoc +++ b/modules/develop/pages/connect/cookbooks/index.adoc @@ -1,3 +1,4 @@ = Cookbooks :page-layout: index -:page-aliases: cookbooks:index.adoc \ No newline at end of file +:page-aliases: cookbooks:index.adoc +:description: Step-by-step Redpanda Connect cookbooks that walk through complete, real-world pipeline builds in Redpanda Cloud. \ No newline at end of file diff --git a/modules/develop/pages/connect/guides/index.adoc b/modules/develop/pages/connect/guides/index.adoc index 187672eec..93cd38501 100644 --- a/modules/develop/pages/connect/guides/index.adoc +++ b/modules/develop/pages/connect/guides/index.adoc @@ -1,3 +1,4 @@ = Guides :page-layout: index -:page-aliases: guides:index.adoc \ No newline at end of file +:page-aliases: guides:index.adoc +:description: Guides for building and operating Redpanda Connect pipelines in Redpanda Cloud, from Bloblang mappings to deployment patterns. \ No newline at end of file diff --git a/modules/reference/pages/glossary.adoc b/modules/reference/pages/glossary.adoc index 22f9a0e70..a4455adfd 100644 --- a/modules/reference/pages/glossary.adoc +++ b/modules/reference/pages/glossary.adoc @@ -1 +1,2 @@ = Glossary +:description: Definitions of the streaming, cloud, and Redpanda-specific terms used throughout the Redpanda Cloud documentation.