From 112809592b88932463dc5e0360ad5f7df77153cc Mon Sep 17 00:00:00 2001 From: Michael Ernest Date: Tue, 17 Mar 2026 12:00:25 -0700 Subject: [PATCH 1/5] fix(DOC-1940): clarify rpk topic consume keeps connection open Add a note explaining that rpk topic consume runs indefinitely by default, waiting for new records. Documents how to exit: Ctrl+C, --num, or an end offset with --offset. Co-Authored-By: Claude Sonnet 4.6 --- .../reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc | 6 ++++++ 1 file changed, 6 insertions(+) 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 46842db279..8e13acacf7 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc @@ -7,6 +7,12 @@ Consuming records reads from any amount of input topics, formats each record according to `--format`, and prints them to `STDOUT`. The output formatter understands a wide variety of formats. +By default, `rpk topic consume` opens a persistent connection and waits +indefinitely for new records to arrive. It does not exit after consuming +existing records. To stop consuming, press `Ctrl+C`, or use `--num` to exit +after a fixed number of records, or specify an end offset with `--offset` +(for example, `-o start:end`). + The default output format `--format json` is a special format that outputs each record as JSON. From 0230f0827ddaf6b44540f1855c4b4e85a98c30bf Mon Sep 17 00:00:00 2001 From: Michael Ernest Date: Thu, 19 Mar 2026 09:39:04 -0700 Subject: [PATCH 2/5] fix(DOC-1940): polish rpk topic consume prose - Change -o start:end example to -o :end per daisukebe review - Use kbd:[Ctrl+C] macro for keyboard shortcut - Simplify --format json description; remove vague "special format" - Fix "prints the number in as ASCII" -> "as ASCII" - Use present tense: "will have their values printed" -> "have" Co-Authored-By: Claude Sonnet 4.6 --- .../pages/rpk/rpk-topic/rpk-topic-consume.adoc | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) 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 8e13acacf7..116f1d3104 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc @@ -9,12 +9,11 @@ understands a wide variety of formats. By default, `rpk topic consume` opens a persistent connection and waits indefinitely for new records to arrive. It does not exit after consuming -existing records. To stop consuming, press `Ctrl+C`, or use `--num` to exit +existing records. To stop consuming, press kbd:[Ctrl+C], or use `--num` to exit after a fixed number of records, or specify an end offset with `--offset` -(for example, `-o start:end`). +(for example, `-o :end`). -The default output format `--format json` is a special format that outputs each -record as JSON. +`--format json` is the default, and outputs each record as a JSON object. include::reference:partial$topic-format.adoc[] @@ -88,7 +87,7 @@ specification, similar to timestamps above. Unpacking text can allow translating binary input into readable output. If a value is a big-endian uint32, `%v` prints the raw four bytes, while -`%v{unpack[>I]}` prints the number in as ASCII. If unpacking exhausts the +`%v{unpack[>I]}` prints the number as ASCII. If unpacking exhausts the input before something is unpacked fully, an error message is appended to the output. @@ -109,7 +108,7 @@ of the above rules about `%K`, `%V`, text, and numbers apply. Values for consumed records can be omitted by using the `--meta-only` flag. -Tombstone records (records with a `null` value) have their value omitted from the JSON output by default. All other records, including those with an empty-string value (`""`), will have their values printed. +Tombstone records (records with a `null` value) have their value omitted from the JSON output by default. All other records, including those with an empty-string value (`""`), have their values printed. == Offsets From 2fd337c0f8ce6847d823b93c9138fa0c3256d388 Mon Sep 17 00:00:00 2001 From: Michael Ernest Date: Tue, 24 Mar 2026 12:29:37 -0700 Subject: [PATCH 3/5] fix(DOC-1940): move connection behavior note to manual section below flags table Co-Authored-By: Claude Sonnet 4.6 --- .../pages/rpk/rpk-topic/rpk-topic-consume.adoc | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) 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 116f1d3104..0067a1a9a1 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc @@ -7,12 +7,6 @@ Consuming records reads from any amount of input topics, formats each record according to `--format`, and prints them to `STDOUT`. The output formatter understands a wide variety of formats. -By default, `rpk topic consume` opens a persistent connection and waits -indefinitely for new records to arrive. It does not exit after consuming -existing records. To stop consuming, press kbd:[Ctrl+C], or use `--num` to exit -after a fixed number of records, or specify an end offset with `--offset` -(for example, `-o :end`). - `--format json` is the default, and outputs each record as a JSON object. include::reference:partial$topic-format.adoc[] @@ -262,4 +256,8 @@ any expression. |-v, --verbose |- |Enable verbose logging. |=== +== Connection behavior + +By default, `rpk topic consume` runs continuously, waiting for new records to arrive. It does not exit after consuming existing records. To stop consuming, press kbd:[Ctrl+C]. You can also use `--num` to exit after a fixed number of records, or use `--offset` (for example, `-o :end`) to stop at a specific offset. + // end::single-source[] \ No newline at end of file From 7336c0401dff900c39658148d0474cae4e40c1df Mon Sep 17 00:00:00 2001 From: Joyce Fee Date: Thu, 28 May 2026 11:57:33 -0400 Subject: [PATCH 4/5] docs(DOC-1940): restore auto-gen description, move output note to manual zone Per @micheleRP's review and the constraint that rpk reference pages are fully regenerated from `rpk --help`: the only manual edits that survive regeneration are those below the Flags table. Revert the line-10 wording change in the auto-gen description zone (would have been silently overwritten on the next rpk doc regen), and move the default-output-format clarification into the new == Connection behavior section in the manual zone so it persists. Co-Authored-By: Claude Opus 4.7 --- modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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 0067a1a9a1..fde2c43486 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc @@ -7,7 +7,8 @@ Consuming records reads from any amount of input topics, formats each record according to `--format`, and prints them to `STDOUT`. The output formatter understands a wide variety of formats. -`--format json` is the default, and outputs each record as a JSON object. +The default output format `--format json` is a special format that outputs each +record as JSON. include::reference:partial$topic-format.adoc[] @@ -260,4 +261,6 @@ any expression. By default, `rpk topic consume` runs continuously, waiting for new records to arrive. It does not exit after consuming existing records. To stop consuming, press kbd:[Ctrl+C]. You can also use `--num` to exit after a fixed number of records, or use `--offset` (for example, `-o :end`) to stop at a specific offset. +Records are formatted according to `--format`. The default, `--format json`, prints each record as a JSON object. + // end::single-source[] \ No newline at end of file From 478809ceaf6ec71e4959892dfa2478b91a1e95ae Mon Sep 17 00:00:00 2001 From: Joyce Fee Date: Thu, 28 May 2026 11:59:05 -0400 Subject: [PATCH 5/5] chore: trigger Netlify rebuild