docs: update rpk CLI documentation (v26.2.1-rc2)

docs-data/rpk-overrides.json

@@ -840,7 +840,8 @@
       "description": "Manage and inspect Redpanda cluster configuration, health, and maintenance operations.",
       "$refs": [
         "#/definitions/common-admin-flags"
-      ]
+      ],
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin.adoc"
     },
     "rpk cluster config": {
       "description": "View and modify cluster-wide configuration properties. Changes take effect across all brokers.",
@@ -858,7 +859,8 @@
           "position": "after_description",
           "content": "Cluster properties are Redpanda settings that apply to all brokers in\nthe cluster. These are separate from broker properties, which apply to only that broker and are set with\n`rpk redpanda config`.\n\nUse the `edit` subcommand to interactively modify the cluster configuration, or\n`export` and `import` to write the configuration to a file that can be edited and\nread back later.\n\nThese commands take an optional `--all` flag to include all properties such as\nlow-level tunables (for example, internal buffer sizes) that do not usually need\nto be changed during normal operations. These properties generally require\nsome expertise to set safely, so if in doubt, avoid using `--all`."
         }
-      ]
+      ],
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-config.adoc"
     },
     "rpk cluster storage": {
       "description": "Manage cluster storage, including mounting and unmounting topics from Tiered Storage.",
@@ -1801,7 +1803,8 @@
         "disabled-only": {
           "description": "List disabled partitions only."
         }
-      }
+      },
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions-list.adoc"
     },
     "rpk cluster partitions move-cancel": {
       "pageAliases": "reference:rpk/rpk-cluster/rpk-cluster-partitions-movement-cancel.adoc"
@@ -2972,10 +2975,11 @@
       ],
       "seeAlso": [
         "xref:reference:rpk/rpk-cluster/rpk-cluster-config-get.adoc[`rpk cluster config get`]"
-      ]
+      ],
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-config-print.adoc"
     },
     "rpk cluster info": {
-      "pageAliases": "reference:rpk/rpk-cluster/rpk-cluster-metadata.adoc"
+      "pageAliases": "reference:rpk/rpk-cluster/rpk-cluster-metadata.adoc, reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers-list.adoc"
     },
     "rpk debug": {
       "pageAliases": "reference:rpk/rpk-debug.adoc"
@@ -3231,7 +3235,11 @@
         "mode": {
           "description": "Operation Mode. Acceptable values: (`sq`, `sq_split`, `mq`)."
         }
-      }
+      },
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
     },
     "rpk redpanda tune": {
       "flags": {
@@ -3258,7 +3266,11 @@
           "position": "after_description",
           "content": "* When running `rpk redpanda tune`, make sure that your current Linux user has root privileges. The autotuner requires privileged access to the Linux kernel settings.\n* To run `rpk redpanda tune all` on a Redpanda broker automatically after broker or host restarts, configure the service `redpanda-tuner`, which runs `rpk redpanda tune all`, to run at boot-up:\n** For RHEL, after installing the rpm package, run `systemctl` to both start and enable the `redpanda-tuner` service:\n+\n[,bash]\n----\nsudo systemctl start redpanda-tuner\nsudo systemctl enable redpanda-tuner\n----\n\n** For Ubuntu, after installing the apt package, run `systemctl` to start the `redpanda-tuner` service (which is already enabled):\n+\n[,bash]\n----\nsudo systemctl start redpanda-tuner\n----"
         }
-      ]
+      ],
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
     },
     "rpk redpanda start": {
       "content": [
@@ -3270,7 +3282,11 @@
           "headingLevel": 2,
           "content": "Redpanda supports a `dev-container` mode with preset configuration for development and test environments.\n\nRun the following command to start Redpanda in `dev-container` mode:\n\n[,bash]\n----\nrpk redpanda start --mode dev-container\n----\n\nThis mode bundles the following flags and cluster properties:\n\nBundled flags:\n\n* xref:reference:rpk/rpk-redpanda/rpk-redpanda-mode.adoc#development-mode[`--overprovisioned`] (disables thread affinity and other production guards; see xref:reference:rpk/rpk-redpanda/rpk-redpanda-mode.adoc#development-mode[`rpk redpanda mode`] for details)\n* `--reserve-memory 0M`\n* `--check=false`\n* `--unsafe-bypass-fsync`\n\nBundled cluster properties:\n\n* `write_caching_default: true`\n* `auto_create_topics_enabled: true`\n* `group_topic_partitions: 3`\n* `storage_min_free_bytes: 10485760 (10MiB)`\n* `topic_partitions_per_shard: 1000`\n* `fetch_reads_debounce_timeout: 10`\n\nAfter Redpanda starts, you can modify cluster properties by running:\n\n[,bash]\n----\nrpk config set <key> <value>\n----"
         }
-      ]
+      ],
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
     },
     "rpk iotune": {
       "content": [
@@ -3282,7 +3298,11 @@
           "headingLevel": 2,
           "content": "Running `rpk iotune` produces an output file that by default is saved in `/etc/redpanda/io-config.yaml`.\n\nThe contents of an example `io-config.yaml`:\n\n[,yaml]\n----\ndisks:\n- mountpoint: /var/lib/redpanda/data\n  read_iops: 40952\n  read_bandwidth: 5638210048\n  write_iops: 6685\n  write_bandwidth: 1491679488\n----\n\n=== Related topics\n\n* xref:manage:io-optimization.adoc[Optimize I/O]"
         }
-      ]
+      ],
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
     },
     "rpk cloud byoc install": {
       "content": [
@@ -3372,7 +3392,11 @@
           "headingLevel": 2,
           "content": "=== Development mode\n\nDevelopment mode (`development` or `dev`) includes the following development-only settings:\n\n* Sets `developer_mode` to `true`. This starts Redpanda with dev-mode only settings, including:\n** No minimal memory limits are enforced.\n** No core assignment rules for Redpanda brokers are enforced.\n** Enables write caching, which is a relaxed mode of `acks=all` that acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to fsync to disk. This provides lower latency while still ensuring that a majority of brokers acknowledge the write. For more information, or to disable this, see xref:develop:manage-topics/config-topics.adoc#configure-write-caching[write caching].\n** Bypasses `fsync` (from https://docs.seastar.io/master/structseastar_1_1reactor%5F%5Foptions.html#ad66cb23f59ed5dfa8be8189313988692[Seastar option `unsafe_bypass_fsync`^]), which results in unrealistically fast clusters and may result in data loss.\n* Sets `overprovisioned` to `true`. Redpanda expects a dev system to be an overprovisioned environment. Based on a https://docs.seastar.io/master/structseastar_1_1reactor%5F%5Foptions.html#a0caf6c2ad579b8c22e1352d796ec3c1d[Seastar option^], setting `overprovisioned` disables thread affinity, zeros idle polling time, and disables busy-poll for disk I/O.\n* Sets all autotuner xref:reference:rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc#tuners[tuners] to `false`. The tuners are intended to run only for production mode.\n\n=== Production mode\n\nProduction mode (`production` or `prod`) disables dev-mode settings:\n\n* `developer_mode: false`\n* `overprovisioned: false`\n\nIt also enables a set of tuners of the autotuner. For descriptions about the tuners, see xref:reference:rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc#tuners[Tuners] in the xref:reference:rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc[rpk redpanda tune list] command reference.\n\n=== Recovery mode\n\nRecovery mode (`recovery`) sets the broker configuration property `recovery_mode_enabled` to `true`. This provides a stable environment for troubleshooting and restoring a failed cluster."
         }
-      ]
+      ],
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
     },
     "rpk cluster maintenance status": {
       "description": "Report maintenance status.\n\nThis command reports maintenance status for each broker in the cluster. The output is presented as a table with each row representing a broker in the cluster. The output can be used to monitor the progress of node draining.",
@@ -3386,6 +3410,83 @@
         }
       ],
       "_note": "Description override replaces the raw help output, which otherwise renders as a broken table. The example output and field table live in a content section because literal blocks are stripped from description overrides."
+    },
+    "rpk cluster partitions": {
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc"
+    },
+    "rpk cluster brokers": {
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers.adoc"
+    },
+    "rpk cluster brokers decommission": {
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission.adoc"
+    },
+    "rpk cluster brokers decommission-status": {
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers-decommission-status.adoc"
+    },
+    "rpk cluster brokers recommission": {
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers-recommission.adoc"
+    },
+    "rpk cluster loggers": {
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level.adoc"
+    },
+    "rpk cluster loggers set": {
+      "pageAliases": "reference:rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc"
+    },
+    "rpk redpanda check": {
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
+    },
+    "rpk redpanda config": {
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
+    },
+    "rpk redpanda config bootstrap": {
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
+    },
+    "rpk redpanda config init": {
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
+    },
+    "rpk redpanda config print": {
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
+    },
+    "rpk redpanda config set": {
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
+    },
+    "rpk redpanda stop": {
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
+    },
+    "rpk redpanda tune help": {
+      "platforms": [
+        "linux"
+      ],
+      "_note": "Linux-only command. The v26.2.1-rc2 tree data wrongly reported darwin support, so pin the platform here."
+    },
+    "rpk k8s uninstall": {
+      "description": "Uninstall the Redpanda Kubernetes plugin.\n\nBy default this removes only the rpk-managed plugin binary (`~/.local/bin/.rpk.managed-k8s`). If the resolved plugin was not installed by `rpk` (a self-managed copy, for example one you downloaded or installed through a package manager), `rpk` refuses to remove it unless you pass `--force`.\n\nIf the resolved plugin shadows other k8s plugin copies elsewhere on your PATH, those are left in place unless you pass `--include-shadowed`.",
+      "_note": "The generated help text for this command gets mangled by the inline-code text transformations, so override it with clean text."
+    },
+    "rpk check install": {
+      "description": "Install Redpanda Check.\n\nThis command installs the latest version by default.\n\nAlternatively, you may specify a version using the `--check-version` flag.\n\nYou may force the installation using the `--force` flag.",
+      "_note": "The source help text is missing a period after the summary sentence, which breaks the generated meta description."
     }
   }
 }