Skip to content

Commit 5218dd5

Browse files
mfernestclaude
andcommitted
fix(DOC-1675): restore auto-gen flags table to main; keep manual zone only
Per Michele's review: manual edits to the auto-generated flags table will be overwritten on the next rpk doc regeneration. Restoring the flags table to main's version; retaining only the safe manual zone changes (heading, prose rewrite, overprovisioned xref). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 66aab3c commit 5218dd5

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Bundled cluster properties:
3434
* `topic_partitions_per_shard: 1000`
3535
* `fetch_reads_debounce_timeout: 10`
3636

37-
After Redpanda starts, modify cluster properties by running:
37+
After Redpanda starts, you can modify cluster properties by running:
3838

3939
[,bash]
4040
----
@@ -77,7 +77,7 @@ Pandaproxy addresses to advertise.
7777
<host>:<port>
7878
----
7979

80-
|--check |- |When set to `false`, disables system checking before
80+
|--check |- |When set to `false`, will disable system checking before
8181
starting `redpanda` (default `true`).
8282

8383
|-h, --help |- |Help for start.
@@ -128,9 +128,13 @@ to.
128128
<scheme>:<host>:<port>\|<name>
129129
----
130130

131-
|--timeout |duration |The maximum time to wait for the system checks and tuning processes to complete. The value passed is a sequence of decimal numbers, each with an optional fraction and a unit suffix, such as `300ms`, `1.5s` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h` (default 10s).
131+
|--timeout |duration |The maximum time to wait for the checks and tune
132+
processes to complete. The value passed is a sequence of decimal
133+
numbers, each with optional fraction and a unit suffix, such as
134+
`300ms`, `1.5s` or `2h45m`. Valid time units are `ns`, `us`
135+
(or `µs`), `ms`, `s`, `m`, `h` (default 10s).
132136

133-
|--tune |- |Enables tuning before starting `redpanda`.
137+
|--tune |- |When present will enable tuning before starting `redpanda`.
134138

135139
|--well-known-io |string |The cloud vendor and VM type, in the format
136140

@@ -139,9 +143,9 @@ to.
139143
<vendor>:<vm-type>:<storage-type>
140144
----
141145

142-
|--config |string |Path to the Redpanda or `rpk` configuration file. If not specified, `rpk` searches `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
146+
|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
143147

144-
|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terse detail.
148+
|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
145149

146150
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
147151

0 commit comments

Comments
 (0)