@redpanda-data/docs-extensions-and-macros 4.11.1 → 4.12.0

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

@@ -7,6 +7,9 @@
 {{#if is_deprecated}}
 // tag::deprecated[]
 {{/if}}
+{{#if is_experimental_property}}
+// tag::experimental[]
+{{/if}}
 {{#if cloud_supported}}
 // tag::redpanda-cloud[]
 {{/if}}
@@ -21,105 +24,134 @@
 {{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])
+.Enterprise license required
+[NOTE]
+====
+*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.
+NOTE: This property is available only in Redpanda Cloud BYOC deployments.
 endif::[]
-{{/if}}
-{{#if type}}
 
-*Type:* {{type}}
 {{/if}}
-{{#if acceptable_values}}
 
-*Accepted values:* {{{acceptable_values}}}
-{{/if}}
+[cols="1e,2a"]
+|===
+| Property | Value
+
+| Type
+| `{{type}}`{{#if (or enum items.enum)}} (enum){{/if}}
+
+{{#if enum}}
+| Accepted Values
+| {{#each enum}}`{{this}}`{{#if (isEnterpriseEnum this ../x-enum-metadata)}} (Enterprise){{/if}}{{#unless @last}}, {{/unless}}{{/each}}
+{{else}}{{#if items.enum}}
+| Accepted Values
+| {{#each items.enum}}`{{this}}`{{#if (isEnterpriseEnum this ../items.x-enum-metadata)}} (Enterprise){{/if}}{{#unless @last}}, {{/unless}}{{/each}}
+{{else}}{{#if acceptable_values}}
+| Accepted values
+| {{{acceptable_values}}}
+{{/if}}{{/if}}{{/if}}
 {{#if corresponding_cluster_property}}
 
-*Related cluster property:* xref:reference:cluster-properties.adoc#{{corresponding_cluster_property}}[{{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}}`]
+| Range
+| [`{{minimum}}`, `{{maximum}}`]
 {{else}}
 {{#if minimum}}
 
-*Minimum value:* `{{minimum}}`
+| Minimum
+| `{{minimum}}`
 {{/if}}
 {{#if maximum}}
 
-*Maximum value:* `{{maximum}}`
+| Maximum
+| `{{maximum}}`
 {{/if}}
 {{/if}}
 {{#if (ne default undefined)}}
-{{#if cloud_supported}}
 
+| Default
+| {{#if cloud_supported}}
 ifdef::env-cloud[]
-*Default:* Available in the Redpanda Cloud Console
+Available in the Redpanda Cloud Console
 endif::[]
 ifndef::env-cloud[]
-*Default:* `{{formatPropertyValue default type}}`
+`{{formatPropertyValue default type}}`{{#if default_human_readable}} ({{default_human_readable}}){{/if}}
+endif::[]{{else}}
+ifdef::env-cloud[]
+Available in the Redpanda Cloud Console
 endif::[]
-{{else}}
-
-*Default:* `{{formatPropertyValue default type}}`
-{{/if}}
+ifndef::env-cloud[]
+`{{formatPropertyValue default type}}`{{#if default_human_readable}} ({{default_human_readable}}){{/if}}
+endif::[]{{/if}}
 {{/if}}
 
-*Nullable:* {{#if nullable}}Yes{{else}}No{{/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}}
+| Restored on xref:manage:whole-cluster-restore.adoc[Whole Cluster Restore]
+| {{#if (ne gets_restored false)}}Yes{{else}}No{{/if}}
 endif::[]
 {{#if example}}
 
-{{{renderPropertyExample this}}}
+| Example
+| {{{example}}}
 {{/if}}
 {{#if related_topics}}
 {{#with (allTopicsConditional related_topics) as |sectionType|}}
 
 {{#if (eq sectionType "cloud")}}
 ifdef::env-cloud[]
-*Related topics:*
-
+| Related topics
+|
 {{#each ../related_topics}}
 {{#with (parseRelatedTopic this)}}
-* {{{value}}}
+{{#if (gt ../../related_topics.length 1)}}* {{/if}}{{{value}}}
 {{/with}}
 {{/each}}
 endif::[]
 {{else if (eq sectionType "self-managed")}}
 ifndef::env-cloud[]
-*Related topics:*
-
+| Related topics
+|
 {{#each ../related_topics}}
 {{#with (parseRelatedTopic this)}}
-* {{{value}}}
+{{#if (gt ../../related_topics.length 1)}}* {{/if}}{{{value}}}
 {{/with}}
 {{/each}}
 endif::[]
 {{else}}
-*Related topics:*
-
+| Related topics
+|
 {{#each ../related_topics}}
 {{#with (parseRelatedTopic this)}}
 {{#if (eq type "cloud")}}
 ifdef::env-cloud[]
-* {{{value}}}
+{{#if (gt ../../related_topics.length 1)}}* {{/if}}{{{value}}}
 endif::[]
 {{else if (eq type "self-managed")}}
 ifndef::env-cloud[]
-* {{{value}}}
+{{#if (gt ../../related_topics.length 1)}}* {{/if}}{{{value}}}
 endif::[]
 {{else}}
-* {{{value}}}
+{{#if (gt ../../related_topics.length 1)}}* {{/if}}{{{value}}}
 {{/if}}
 {{/with}}
 {{/each}}
@@ -129,11 +161,17 @@ endif::[]
 {{#if aliases}}
 
 // tag::self-managed-only[]
-*Aliases:* {{join aliases ", "}}
+| Aliases
+| {{join aliases ", "}}
 // end::self-managed-only[]
 {{/if}}
 
+|===
+
 ---
+{{#if is_experimental_property}}
+// end::experimental[]
+{{/if}}
 {{#if cloud_supported}}
 // end::redpanda-cloud[]
 {{/if}}