@redpanda-data/docs-extensions-and-macros 5.37.6 → 5.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -110,6 +110,10 @@
|
|
|
110
110
|
"type": "string",
|
|
111
111
|
"description": "Override the command description. Replaces only the main description; sections from rpk output are preserved."
|
|
112
112
|
},
|
|
113
|
+
"upstream_ref": {
|
|
114
|
+
"type": "string",
|
|
115
|
+
"description": "The upstream issue or PR (against the engineering repo whose defective rpk help text this description patches, either the short form 'redpanda-data/streaming-enterprise#12345' or the full URL) that will make this description override redundant once merged and released. A description override is a stopgap, not a fix: set this so the override is born with a retirement path, and remove both the override and this field once the fix ships. Only meaningful alongside 'description' — has no effect on generation or rendering."
|
|
116
|
+
},
|
|
113
117
|
"appendToDescription": {
|
|
114
118
|
"type": "string",
|
|
115
119
|
"description": "Content to append to the auto-generated description instead of replacing it."
|
|
@@ -297,6 +301,10 @@
|
|
|
297
301
|
"type": "string",
|
|
298
302
|
"description": "Override the flag description"
|
|
299
303
|
},
|
|
304
|
+
"upstream_ref": {
|
|
305
|
+
"type": "string",
|
|
306
|
+
"description": "The upstream issue or PR (against the engineering repo whose defective rpk flag usage text this description patches) that will make this description override redundant once merged and released. Either the short form 'redpanda-data/streaming-enterprise#12345' or the full URL is accepted. A description override is a stopgap, not a fix: set this so the override is born with a retirement path, and remove both the override and this field once the fix ships. Only meaningful alongside 'description' -- has no effect on generation or rendering."
|
|
307
|
+
},
|
|
300
308
|
"type": {
|
|
301
309
|
"type": "string",
|
|
302
310
|
"description": "Override the flag type display"
|