@redpanda-data/docs-extensions-and-macros 5.3.0 → 5.3.2

package/tools/rpk-docs/rpk-docs-handler.js

@@ -8,6 +8,7 @@ const os = require('os')
 const semver = require('semver')
 const { findRepoRoot } = require('../../cli-utils/doc-tools-utils')
 const { generateRpkDocs, applyOverridesToTree, resolveReferences, shouldExcludeCommand, shouldUsePartialDir } = require('./generate-rpk-docs')
+const { detectLinuxOnlyFromSource, warnIfDetectionLooksBroken } = require('./detect-platform-commands')
 const { generateRpkDiff, printDiffReport, generateWhatsNewSection, flattenToMap } = require('./report-delta')
 const { loadAndValidateOverrides, ValidationResult } = require('./validate-overrides')
 const { validateDirectory, formatResults } = require('./validate-output')
@@ -656,105 +657,6 @@ function fetchRpkTreeFromLinuxSource(sourcePath, pluginPins = {}) {
   }
 }
 
-/**
- * Scan Go source files for Linux-only build tags
- * Looks for //go:build linux or // +build linux
- * @param {string} sourcePath - Path to rpk Go source directory
- * @returns {Set<string>} Set of Linux-only command paths (e.g., 'rpk redpanda tune')
- */
-function detectLinuxOnlyFromSource(sourcePath) {
-  const linuxOnlyCommands = new Set()
-
-  // Map of source directory patterns to command paths
-  // rpk commands are typically in pkg/cli/cmd/<command>/<subcommand>/
-  const scanDirectory = (dir, prefix = '') => {
-    if (!fs.existsSync(dir)) return
-
-    const entries = fs.readdirSync(dir, { withFileTypes: true })
-
-    for (const entry of entries) {
-      const fullPath = path.join(dir, entry.name)
-
-      if (entry.isDirectory()) {
-        // Recurse into subdirectories
-        const newPrefix = prefix ? `${prefix} ${entry.name}` : entry.name
-        scanDirectory(fullPath, newPrefix)
-      } else if (entry.name.endsWith('.go') && !entry.name.endsWith('_test.go')) {
-        // Check Go files for build tags
-        try {
-          const content = fs.readFileSync(fullPath, 'utf8')
-          const firstLines = content.split('\n').slice(0, 20).join('\n')
-
-          // Check for Linux build constraints
-          const hasLinuxTag = /\/\/go:build\s+.*linux/.test(firstLines) ||
-                             /\/\/\s*\+build\s+.*linux/.test(firstLines)
-
-          if (hasLinuxTag) {
-            // Try to determine command path from file location
-            const commandPath = inferCommandPath(sourcePath, fullPath, entry.name)
-            if (commandPath) {
-              linuxOnlyCommands.add(commandPath)
-            }
-          }
-        } catch (err) {
-          // Skip files we can't read
-        }
-      }
-    }
-  }
-
-  // Scan the cmd/rpk directory for command implementations
-  const cmdDir = path.join(sourcePath, 'pkg', 'cli', 'cmd')
-  if (fs.existsSync(cmdDir)) {
-    scanDirectory(cmdDir, 'rpk')
-  }
-
-  // Also check the older structure
-  const oldCmdDir = path.join(sourcePath, 'cmd', 'rpk')
-  if (fs.existsSync(oldCmdDir)) {
-    scanDirectory(oldCmdDir, 'rpk')
-  }
-
-  return linuxOnlyCommands
-}
-
-/**
- * Infer command path from Go source file location
- * @param {string} sourcePath - Root source path
- * @param {string} filePath - Full path to Go file
- * @param {string} fileName - Name of the Go file
- * @returns {string|null} Command path or null
- */
-function inferCommandPath(sourcePath, filePath, fileName) {
-  // Get relative path from source root
-  const relativePath = filePath.replace(sourcePath, '').replace(/^\//, '')
-
-  // Common patterns:
-  // pkg/cli/cmd/redpanda/tune.go -> rpk redpanda tune
-  // pkg/cli/cmd/redpanda/start.go -> rpk redpanda start
-  // cmd/rpk/iotune/iotune.go -> rpk iotune
-
-  // Remove common prefixes and file extension
-  let parts = relativePath
-    .replace(/^pkg\/cli\/cmd\//, '')
-    .replace(/^cmd\/rpk\//, '')
-    .replace(/\.go$/, '')
-    .split('/')
-
-  // If file name matches directory name, use directory only
-  // e.g., iotune/iotune.go -> iotune
-  if (parts.length > 1 && parts[parts.length - 1] === parts[parts.length - 2]) {
-    parts = parts.slice(0, -1)
-  }
-
-  // Filter out common non-command directories
-  parts = parts.filter(p => !['internal', 'common', 'config', 'cmd'].includes(p))
-
-  if (parts.length === 0) return null
-
-  return 'rpk ' + parts.join(' ')
-}
-
 /**
  * Add platform markers to command tree based on source analysis
  * @param {Object} tree - Command tree from rpk --print-tree
@@ -769,11 +671,18 @@ function addPlatformMarkersFromSource(tree, linuxOnlyCommands) {
            [...linuxOnlyCommands].some(loc => cmdPath.startsWith(loc + ' '))
   }
 
+  // Collect every tree path actually marked Linux-only so the persisted
+  // linux_only_commands list is fully expanded (each descendant listed),
+  // matching what dynamic Linux-vs-Darwin tree comparison produces.
+  const markedPaths = new Set()
+
   const markCommands = (commands, parentPath = 'rpk') => {
     if (!commands) return commands
     return commands.map(cmd => {
       const fullPath = `${parentPath} ${cmd.name}`
-      const platforms = isLinuxOnly(fullPath)
+      const linuxOnly = isLinuxOnly(fullPath)
+      if (linuxOnly) markedPaths.add(fullPath)
+      const platforms = linuxOnly
         ? [PLATFORMS.LINUX]
         : [PLATFORMS.LINUX, PLATFORMS.DARWIN]
       return {
@@ -792,11 +701,15 @@ function addPlatformMarkersFromSource(tree, linuxOnlyCommands) {
     }
   }
 
+  const markedCommands = markCommands(tree.commands)
+
   return {
     ...tree,
     platforms: [PLATFORMS.LINUX, PLATFORMS.DARWIN],
-    linux_only_commands: [...linuxOnlyCommands],
-    commands: markCommands(tree.commands)
+    // Union of detected paths and marked tree paths: keeps detected roots
+    // even when the tree was built on a platform where they don't exist
+    linux_only_commands: [...new Set([...linuxOnlyCommands, ...markedPaths])].sort(),
+    commands: markedCommands
   }
 }
 
@@ -1166,6 +1079,37 @@ function makeLinkablePredicate(overridesData) {
   }
 }
 
+// Command subtrees whose changes never belong in the Self-Managed What's
+// new. rpk ai's documentation home is adp-docs, and the ADP release notes
+// already cover its CLI changes per release. The plugin-release receiver
+// workflow excludes ai from --update-whats-new for exactly this reason; the
+// full-regeneration path must agree, or a full run floods the Self-Managed
+// release notes with rpk ai entries (a rename release alone produces 21 new
+// plus 21 removed bullets).
+const WHATS_NEW_EXCLUDED_SUBTREES = ['rpk ai']
+
+/**
+ * Return a copy of diffData without entries under the excluded subtrees.
+ * Only the published What's-new block filters; diff reports and PR
+ * summaries keep the full picture.
+ * @param {Object} diffData - Diff from generateRpkDiff
+ * @param {string[]} [excluded] - Command-path prefixes to drop
+ * @returns {Object} Filtered copy
+ */
+function filterDiffForWhatsNew(diffData, excluded = WHATS_NEW_EXCLUDED_SUBTREES) {
+  const outside = (cmdPath) => !excluded.some(prefix =>
+    cmdPath === prefix || (typeof cmdPath === 'string' && cmdPath.startsWith(prefix + ' ')))
+  const details = diffData.details || {}
+  const filteredDetails = { ...details }
+  for (const key of ['newCommands', 'newlyDeprecatedCommands', 'removedCommands', 'descriptionChanges']) {
+    if (Array.isArray(details[key])) filteredDetails[key] = details[key].filter(e => outside(e.path))
+  }
+  for (const key of ['newFlags', 'removedFlags', 'changedDefaults', 'changedFlagTypes', 'changedFlagRequirements', 'changedFlagDescriptions']) {
+    if (Array.isArray(details[key])) filteredDetails[key] = details[key].filter(e => outside(e.commandPath))
+  }
+  return { ...diffData, details: filteredDetails }
+}
+
 function updateWhatsNewFile(diffData, whatsNewPath, version, options = {}) {
   // Each block opens with a "=== <version>" heading so accumulated blocks
   // (successive RCs, multiple plugin releases) never collide on section ids
@@ -1437,8 +1381,28 @@ function acquireRpkBinary(rpkVersion, options = {}) {
     console.warn(`Native build failed (${nativeErr.message.split('\n')[0]}); building in a container...`)
     const goVersion = getRequiredGoVersion(sourcePath)
     const goImage = goVersion ? `golang:${goVersion}` : 'golang:1'
+    // Cross-compile for the HOST platform: the container reports
+    // GOOS=linux, and a linux binary dies silently when executed on the
+    // macOS host that needs it for plugin installs (review finding on the
+    // 5.3.0 train). rpk builds with CGO disabled, so cross-compilation
+    // from the linux container is safe.
+    // Only macOS and Linux hosts are supported: mapping anything else to
+    // linux would hand a Windows host an unrunnable binary, the exact bug
+    // class the cross-compile fixes (review finding on #238).
+    if (process.platform !== 'darwin' && process.platform !== 'linux') {
+      throw new Error(
+        `${nativeErr.message}\n` +
+        `Container fallback does not support host platform "${process.platform}". ` +
+        'Update Go, or pass --rpk-bin <path> to use an existing rpk binary.'
+      )
+    }
+    const hostGoos = process.platform === 'darwin' ? 'darwin' : 'linux'
+    const hostGoarch = process.arch === 'arm64' ? 'arm64' : 'amd64'
     const buildResult = spawnSync('docker', [
       'run', '--rm',
+      '-e', `GOOS=${hostGoos}`,
+      '-e', `GOARCH=${hostGoarch}`,
+      '-e', 'CGO_ENABLED=0',
       '-v', `${path.resolve(sourcePath)}:/rpk-source:ro`,
       '-v', `${workDir}:/out`,
       '-w', '/rpk-source',
@@ -2001,10 +1965,14 @@ async function handleRpkDocsGeneration(options = {}) {
         // render without xrefs because plugin subtrees may render as
         // partials with no linkable pages.
         if (whatsNewPath) {
-          const label = resolvedVersion
-            ? `${plugin} plugin ${resolvedVersion}`
-            : `${plugin} plugin`
-          updateWhatsNewFile(pluginDiffData, whatsNewPath, label, { xrefs: false, sectionHeading: '== rpk plugins' })
+          if (WHATS_NEW_EXCLUDED_SUBTREES.includes(`rpk ${plugin}`)) {
+            console.log(`Skipping What's new for rpk ${plugin}: its documentation home covers CLI changes in its own release notes`)
+          } else {
+            const label = resolvedVersion
+              ? `${plugin} plugin ${resolvedVersion}`
+              : `${plugin} plugin`
+            updateWhatsNewFile(pluginDiffData, whatsNewPath, label, { xrefs: false, sectionHeading: '== rpk plugins' })
+          }
         }
       }
 
@@ -2117,7 +2085,7 @@ async function handleRpkDocsGeneration(options = {}) {
 
           // Update what's-new file if requested
           if (whatsNewPath) {
-            updateWhatsNewFile(diffData, whatsNewPath, rpkVersion, { linkable: makeLinkablePredicate(overridesData), hasSubcommands: makeSubcommandPredicate(tree) })
+            updateWhatsNewFile(filterDiffForWhatsNew(diffData), whatsNewPath, rpkVersion, { linkable: makeLinkablePredicate(overridesData), hasSubcommands: makeSubcommandPredicate(tree) })
           }
         } else {
           console.warn(`Warning: Could not load previous version ${diffVersion} for diff`)
@@ -2217,10 +2185,17 @@ async function handleRpkDocsGeneration(options = {}) {
     rpkVersion = effectiveRef || 'local'
 
     // Step 2: Detect Linux-only commands
-    // Try dynamic detection first (compare Linux vs Darwin builds)
-    // Fall back to static lists for plugins and known commands
+    // Static detection (build-constraint analysis) works on any platform,
+    // including Linux CI runners. Dynamic detection (comparing Linux vs
+    // Darwin builds) supplements it below when the host can run both.
     console.log('\nAnalyzing source for Linux-only commands...')
     let linuxOnlyCommands = detectLinuxOnlyFromSource(sourcePath)
+    if (linuxOnlyCommands.size > 0) {
+      console.log(`Static detection found ${linuxOnlyCommands.size} Linux-only command path(s):`)
+      for (const cmd of [...linuxOnlyCommands].sort()) {
+        console.log(`  - ${cmd}`)
+      }
+    }
 
     // Step 3: Build rpk and get command tree
     // Use Docker if available (for running rpk plugins in Linux)
@@ -2230,8 +2205,19 @@ async function handleRpkDocsGeneration(options = {}) {
     const canBuildNative = goCheck.status === 0
     const canBuildLinux = dockerCheck.status === 0
 
-    // Dynamic detection: if we can build on both platforms, compare the trees
-    if (canBuildLinux && canBuildNative && os.platform() !== 'linux') {
+    // Dynamic detection: if we can build on both platforms, compare the trees.
+    // Only possible on non-Linux hosts: a Linux runner can cross-compile a
+    // darwin rpk but cannot execute it to get its command tree, so Linux CI
+    // relies on the static detection above.
+    // RPK_DOCS_SKIP_DYNAMIC_DETECTION=1 forces the static-only path (useful
+    // for testing what a Linux CI runner would produce).
+    const skipDynamicDetection = ['1', 'true'].includes(
+      String(process.env.RPK_DOCS_SKIP_DYNAMIC_DETECTION || '').toLowerCase()
+    )
+    if (skipDynamicDetection) {
+      console.log('\nDynamic platform detection disabled via RPK_DOCS_SKIP_DYNAMIC_DETECTION')
+    }
+    if (canBuildLinux && canBuildNative && os.platform() !== 'linux' && !skipDynamicDetection) {
       console.log('\nBuilding rpk on both Linux and Darwin for dynamic platform detection...')
 
       try {
@@ -2297,6 +2283,12 @@ async function handleRpkDocsGeneration(options = {}) {
       )
     }
 
+    // Tripwire: an empty combined detection result while the source tree
+    // demonstrably contains Linux-gated files means the scan is broken and
+    // Linux-only pages are about to be published as cross-platform
+    // (see redpanda-data/docs#1831).
+    warnIfDetectionLooksBroken(sourcePath, linuxOnlyCommands)
+
     // Step 4: Add platform markers based on detection
     // This includes both source scanning results and static fallback lists
     tree = addPlatformMarkersFromSource(tree, linuxOnlyCommands)
@@ -2413,7 +2405,7 @@ async function handleRpkDocsGeneration(options = {}) {
 
         // Update what's-new file if requested
         if (whatsNewPath) {
-          updateWhatsNewFile(diffData, whatsNewPath, rpkVersion, { linkable: makeLinkablePredicate(overridesData), hasSubcommands: makeSubcommandPredicate(tree) })
+          updateWhatsNewFile(filterDiffForWhatsNew(diffData), whatsNewPath, rpkVersion, { linkable: makeLinkablePredicate(overridesData), hasSubcommands: makeSubcommandPredicate(tree) })
         }
       } else {
         console.warn(`Warning: Could not load previous version ${diffVersion} for diff`)
@@ -2827,6 +2819,7 @@ module.exports = {
   getPlatformDescription,
   getCurrentPlatform,
   updateOverridesWithIntroducedVersions,
+  filterDiffForWhatsNew,
   computeDescriptionCoverage,
   updateWhatsNewFile,
   KNOWN_PLUGINS,

package/tools/rpk-docs/templates/command.hbs

@@ -389,8 +389,20 @@ This section provides examples of how to use `{{commandPath}}`.
 |Command |Description
 
 {{#each subcommands}}
+{{#if cloudOnly}}
+ifdef::env-cloud[]
+{{/if}}
+{{#if selfHostedOnly}}
+ifndef::env-cloud[]
+{{/if}}
 |xref:{{xrefPath}}[`{{fullPath}}`]
 |{{{shortDesc}}}
+{{#if cloudOnly}}
+endif::[]
+{{/if}}
+{{#if selfHostedOnly}}
+endif::[]
+{{/if}}
 
 {{/each}}
 |===

package/tools/rpk-docs/validate-overrides.js

@@ -465,8 +465,24 @@ function validatePlatforms(commandOverride, context) {
 function validateFlags(commandOverride, context) {
   const result = new ValidationResult()
 
+  // cloudOnly and selfHostedOnly are mutually exclusive: setting both wraps
+  // the row in an ifdef::env-cloud + ifndef::env-cloud pair that no build
+  // can satisfy, so the row silently vanishes from BOTH sites.
+  if (commandOverride.cloudOnly && commandOverride.selfHostedOnly) {
+    result.addError(
+      'cloudOnly and selfHostedOnly are both set: the command row is unsatisfiable and disappears from every build. Set at most one.',
+      context
+    )
+  }
+
   if (commandOverride.flags) {
     for (const [flagName, flagOverride] of Object.entries(commandOverride.flags)) {
+      if (flagOverride.cloudOnly && flagOverride.selfHostedOnly) {
+        result.addError(
+          `cloudOnly and selfHostedOnly are both set on flag "${flagName}": the flag row is unsatisfiable and disappears from every build. Set at most one.`,
+          `${context}.flags.${flagName}`
+        )
+      }
       // Validate flag name format
       if (!flagName.match(/^[a-zA-Z][-a-zA-Z0-9]*$/)) {
         result.addWarning(

package/tools/property-extractor/templates/property-backup.hbs

@@ -1,161 +0,0 @@
-{{#if category}}
-// tag::category-{{category}}[]
-{{/if}}
-{{#if exclude_from_docs}}
-// tag::exclude-from-docs[]
-{{/if}}
-{{#if is_deprecated}}
-// tag::deprecated[]
-{{/if}}
-{{#if cloud_supported}}
-// tag::redpanda-cloud[]
-{{/if}}
-=== {{name}}
-{{#if version}}
-
-ifndef::env-cloud[]
-*Introduced in {{version}}*
-endif::[]
-{{/if}}
-{{#if description}}
-
-{{{description}}}
-{{else}}
-
-No description available.
-
-{{/if}}
-{{#if is_enterprise}}
-
-ifndef::env-cloud[]
-*Enterprise license required*: `{{enterprise_value}}` (for license details, see xref:get-started:licensing/index.adoc[Redpanda Licensing])
-endif::[]
-{{/if}}
-{{#if cloud_byoc_only}}
-
-ifdef::env-cloud[]
-NOTE: This property is available only in Redpanda Cloud BYOC deployments.
-endif::[]
-
-{{/if}}
-{{#if units}}
-
-*Unit:* {{units}}
-{{else}}
-{{#if (formatUnits name)}}
-
-*Unit:* {{formatUnits name}}
-{{/if}}
-{{/if}}
-{{#if (ne defined_in "src/v/config/node_config.cc")}}
-{{#if (ne needs_restart undefined)}}
-
-*Requires restart:* {{#if needs_restart}}Yes{{else}}No{{/if}}
-{{/if}}
-{{/if}}
-
-ifndef::env-cloud[]
-*Restored during xref:manage:whole-cluster-restore.adoc[Whole Cluster Restore]:* {{#if (ne gets_restored false)}}Yes{{else}}No{{/if}}
-endif::[]
-{{#if visibility}}
-
-// tag::self-managed-only[]
-*Visibility:* `{{visibility}}`
-// end::self-managed-only[]
-{{/if}}
-{{#if type}}
-
-*Type:* {{type}}
-{{/if}}
-{{#if (and minimum maximum)}}
-
-*Accepted values:* [`{{minimum}}`, `{{maximum}}`]
-{{else}}
-{{#if minimum}}
-
-*Minimum value:* `{{minimum}}`
-{{/if}}
-{{#if maximum}}
-
-*Maximum value:* `{{maximum}}`
-{{/if}}
-{{/if}}
-{{#if (ne default undefined)}}
-
-ifdef::env-cloud[]
-*Default:* Available in the Redpanda Cloud Console
-endif::[]
-ifndef::env-cloud[]
-*Default:* `{{formatPropertyValue default type}}`
-endif::[]
-{{/if}}
-
-*Nullable:* {{#if nullable}}Yes{{else}}No{{/if}}
-{{#if example}}
-
-{{{renderPropertyExample this}}}
-{{/if}}
-{{#if related_topics}}
-{{#with (allTopicsConditional related_topics) as |sectionType|}}
-
-{{#if (eq sectionType "cloud")}}
-ifdef::env-cloud[]
-*Related topics:*
-
-{{#each ../related_topics}}
-{{#with (parseRelatedTopic this)}}
-* {{{value}}}
-{{/with}}
-{{/each}}
-endif::[]
-{{else if (eq sectionType "self-managed")}}
-ifndef::env-cloud[]
-*Related topics:*
-
-{{#each ../related_topics}}
-{{#with (parseRelatedTopic this)}}
-* {{{value}}}
-{{/with}}
-{{/each}}
-endif::[]
-{{else}}
-*Related topics:*
-
-{{#each ../related_topics}}
-{{#with (parseRelatedTopic this)}}
-{{#if (eq type "cloud")}}
-ifdef::env-cloud[]
-* {{{value}}}
-endif::[]
-{{else if (eq type "self-managed")}}
-ifndef::env-cloud[]
-* {{{value}}}
-endif::[]
-{{else}}
-* {{{value}}}
-{{/if}}
-{{/with}}
-{{/each}}
-{{/if}}
-{{/with}}
-{{/if}}
-{{#if aliases}}
-
-// tag::self-managed-only[]
-*Aliases:* {{join aliases ", "}}
-// end::self-managed-only[]
-{{/if}}
-
----
-{{#if cloud_supported}}
-// end::redpanda-cloud[]
-{{/if}}
-{{#if is_deprecated}}
-// end::deprecated[]
-{{/if}}
-{{#if exclude_from_docs}}
-// end::exclude-from-docs[]
-{{/if}}
-{{#if category}}
-// end::category-{{category}}[]
-{{/if}}

package/tools/property-extractor/templates/topic-property-backup.hbs

@@ -1,148 +0,0 @@
-{{#if category}}
-// tag::category-{{category}}[]
-{{/if}}
-{{#if exclude_from_docs}}
-// tag::exclude-from-docs[]
-{{/if}}
-{{#if is_deprecated}}
-// tag::deprecated[]
-{{/if}}
-{{#if cloud_supported}}
-// tag::redpanda-cloud[]
-{{/if}}
-=== {{name}}
-{{#if version}}
-
-*Introduced in {{version}}*
-{{/if}}
-{{#if description}}
-
-{{{description}}}
-{{else}}
-
-No description available.
-{{/if}}
-{{#if is_enterprise}}
-
-ifndef::env-cloud[]
-*Enterprise license required*: `{{enterprise_value}}` (for license details, see xref:get-started:licensing/index.adoc[Redpanda Licensing])
-endif::[]
-{{/if}}
-{{#if cloud_byoc_only}}
-ifdef::env-cloud[]
-NOTE: This property is only available in Redpanda Cloud BYOC deployments.
-endif::[]
-{{/if}}
-{{#if type}}
-
-*Type:* {{type}}
-{{/if}}
-{{#if acceptable_values}}
-
-*Accepted values:* {{{acceptable_values}}}
-{{/if}}
-{{#if corresponding_cluster_property}}
-
-*Related cluster property:* xref:reference:cluster-properties.adoc#{{corresponding_cluster_property}}[{{corresponding_cluster_property}}]
-{{/if}}
-{{#if (and minimum maximum)}}
-
-*Accepted values:* [`{{minimum}}`, `{{maximum}}`]
-{{else}}
-{{#if minimum}}
-
-*Minimum value:* `{{minimum}}`
-{{/if}}
-{{#if maximum}}
-
-*Maximum value:* `{{maximum}}`
-{{/if}}
-{{/if}}
-{{#if (ne default undefined)}}
-{{#if cloud_supported}}
-
-ifdef::env-cloud[]
-*Default:* Available in the Redpanda Cloud Console
-endif::[]
-ifndef::env-cloud[]
-*Default:* `{{formatPropertyValue default type}}`
-endif::[]
-{{else}}
-
-*Default:* `{{formatPropertyValue default type}}`
-{{/if}}
-{{/if}}
-
-*Nullable:* {{#if nullable}}Yes{{else}}No{{/if}}
-
-ifndef::env-cloud[]
-*Restored during xref:manage:whole-cluster-restore.adoc[Whole Cluster Restore]:* {{#if (ne gets_restored false)}}Yes{{else}}No{{/if}}
-endif::[]
-{{#if example}}
-
-{{{renderPropertyExample this}}}
-{{/if}}
-{{#if related_topics}}
-{{#with (allTopicsConditional related_topics) as |sectionType|}}
-
-{{#if (eq sectionType "cloud")}}
-ifdef::env-cloud[]
-*Related topics:*
-
-{{#each ../related_topics}}
-{{#with (parseRelatedTopic this)}}
-* {{{value}}}
-{{/with}}
-{{/each}}
-endif::[]
-{{else if (eq sectionType "self-managed")}}
-ifndef::env-cloud[]
-*Related topics:*
-
-{{#each ../related_topics}}
-{{#with (parseRelatedTopic this)}}
-* {{{value}}}
-{{/with}}
-{{/each}}
-endif::[]
-{{else}}
-*Related topics:*
-
-{{#each ../related_topics}}
-{{#with (parseRelatedTopic this)}}
-{{#if (eq type "cloud")}}
-ifdef::env-cloud[]
-* {{{value}}}
-endif::[]
-{{else if (eq type "self-managed")}}
-ifndef::env-cloud[]
-* {{{value}}}
-endif::[]
-{{else}}
-* {{{value}}}
-{{/if}}
-{{/with}}
-{{/each}}
-{{/if}}
-{{/with}}
-{{/if}}
-{{#if aliases}}
-
-// tag::self-managed-only[]
-*Aliases:* {{join aliases ", "}}
-// end::self-managed-only[]
-{{/if}}
-
----
-{{#if cloud_supported}}
-// end::redpanda-cloud[]
-{{/if}}
-{{#if is_deprecated}}
-// end::deprecated[]
-{{/if}}
-{{#if exclude_from_docs}}
-// end::exclude-from-docs[]
-{{/if}}
-{{#if category}}
-// end::category-{{category}}[]
-{{/if}}