GitHub Issue 51112, corrected incorrect string syntax

Author: ahardin-rh

modules/dynamic-plug-in-sdk-extensions.adoc

@@ -50,12 +50,12 @@ submenus.
 |`submenu` |`boolean` |yes |Whether this group should be displayed as
 submenu
 
-|`insertBefore` |`string | string[]` |yes |Insert this item before the
+|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
 item referenced here.For arrays, the first one found in order is used.
 
-|`insertAfter` |`string | string[]` |yes |Insert this item after the
+|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
 item referenced here.For arrays, the first one found in order is
-used.insertBefore takes precedence.
+used. The `insertBefore` value takes precedence.
 |===
 
 '''''
@@ -119,7 +119,9 @@ which returns actions for the given resource model
 |===
 |Name |Value Type |Optional |Description
 |`alert` |`string` |no |
+
 |`text` |`string` |no |
+
 |`action` |`CodeRef<(alert: any) => void>` |no |
 |===
 
@@ -137,13 +139,13 @@ which returns actions for the given resource model
 [cols=",,,",options="header",]
 |===
 |Name |Value Type |Optional |Description
-|`catalogId` |`string | string[]` |no |The unique identifier for the
+|`catalogId` |`string` \| `string[]` |no |The unique identifier for the
 catalog this provider contributes to.
 
 |`type` |`string` |no |Type ID for the catalog item type.
 
 |`filter` |`CodeRef<(item: CatalogItem) => boolean>` |no |Filters items
-of a specific type. Value is a function that takes CatalogItem[] and
+of a specific type. Value is a function that takes `CatalogItem[]` and
 returns a subset based on the filter criteria.
 |===
 
@@ -161,7 +163,7 @@ returns a subset based on the filter criteria.
 [cols=",,,",options="header",]
 |===
 |Name |Value Type |Optional |Description
-|`catalogId` |`string | string[]` |no |The unique identifier for the
+|`catalogId` |`string` \| `string[]` |no |The unique identifier for the
 catalog this provider contributes to.
 
 |`type` |`string` |no |Type ID for the catalog item type.
@@ -186,7 +188,7 @@ metadata to catalog items of a specific type.
 [cols=",,,",options="header",]
 |===
 |Name |Value Type |Optional |Description
-|`catalogId` |`string | string[]` |no |The unique identifier for the
+|`catalogId` |`string` \| `string[]` |no |The unique identifier for the
 catalog this provider contributes to.
 
 |`type` |`string` |no |Type ID for the catalog item type.
@@ -221,7 +223,7 @@ providers.
 
 |`title` |`string` |no |Title for the catalog item.
 
-|`catalogDescription` |`string | CodeRef<React.ReactNode>` |yes
+|`catalogDescription` |`string` \| `CodeRef<React.ReactNode>` |yes
 |Description for the type specific catalog.
 
 |`typeDescription` |`string` |yes |Description for the catalog item
@@ -370,7 +372,7 @@ Adds a new dashboard card.
 |`tab` |`string` |no |The id of the dashboard tab to which the card will
 be added.
 
-|`position` |`'LEFT' | 'RIGHT' | 'MAIN'` |no |The grid position of the
+|`position` |`'LEFT' \| 'RIGHT' \| 'MAIN'` |no |The grid position of the
 card on the dashboard.
 
 |`component` |`CodeRef<React.ComponentType<{}>>` |no |Dashboard card
@@ -448,7 +450,7 @@ the source of status is a K8s REST API.
 which will be fetched and passed to `healthHandler`.
 
 |`getOperatorsWithStatuses` |`CodeRef<GetOperatorsWithStatuses<T>>` |yes
-|Resolves status for the operators.
+|Resolves status for the Operators.
 
 |`operatorRowLoader`
 |`CodeRef<React.ComponentType<OperatorRowProps<T>>>` |yes |Loader for
@@ -601,7 +603,7 @@ Adds an inventory status group.
 |`id` |`string` |no |The id of the status group.
 
 |`icon`
-|`CodeRef<React.ReactElement<any, string | React.JSXElementConstructor<any>>>`
+|`CodeRef<React.ReactElement<any, string` \| `React.JSXElementConstructor<any>>>`
 |no |React component representing the status group icon.
 |===
 
@@ -695,7 +697,7 @@ Adds a new dashboard tab, placed after the Overview tab.
 |`id` |`string` |no |A unique tab identifier, used as tab link `href`
 and when adding cards to this tab.
 
-|`navSection` |`'home' | 'storage'` |no |NavSection to which the tab
+|`navSection` |`'home' \| 'storage'` |no |NavSection to which the tab
 belongs to
 
 |`title` |`string` |no |The title of the tab.
@@ -871,18 +873,18 @@ attributes to the DOM.
 |`startsWith` |`string[]` |yes |Mark this item as active when the URL
 starts with one of these paths.
 
-|`insertBefore` |`string | string[]` |yes |Insert this item before the
+|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
 item referenced here. For arrays, the first one found in order is used.
 
-|`insertAfter` |`string | string[]` |yes |Insert this item after the
+|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
 item referenced here. For arrays, the first one found in order is used.
 `insertBefore` takes precedence.
 
-|`namespaced` |`boolean` |yes |if true, adds /ns/active-namespace to the
+|`namespaced` |`boolean` |yes |If true, adds `/ns/active-namespace` to the
 end
 
-|`prefixNamespaced` |`boolean` |yes |if true, adds
-/k8s/ns/active-namespace to the begining
+|`prefixNamespaced` |`boolean` |yes |If true, adds
+`/k8s/ns/active-namespace` to the beginning
 |===
 
 '''''
@@ -916,10 +918,10 @@ attributes to the DOM.
 |`startsWith` |`string[]` |yes |Mark this item as active when the URL
 starts with one of these paths.
 
-|`insertBefore` |`string | string[]` |yes |Insert this item before the
+|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
 item referenced here. For arrays, the first one found in order is used.
 
-|`insertAfter` |`string | string[]` |yes |Insert this item after the
+|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
 item referenced here. For arrays, the first one found in order is used.
 `insertBefore` takes precedence.
 
@@ -958,10 +960,10 @@ attributes to the DOM.
 |`startsWith` |`string[]` |yes |Mark this item as active when the URL
 starts with one of these paths.
 
-|`insertBefore` |`string | string[]` |yes |Insert this item before the
+|`insertBefore` |`string \| string[]` |yes |Insert this item before the
 item referenced here. For arrays, the first one found in order is used.
 
-|`insertAfter` |`string | string[]` |yes |Insert this item after the
+|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
 item referenced here. For arrays, the first one found in order is used.
 `insertBefore` takes precedence.
 
@@ -991,10 +993,10 @@ belongs to. If not specified, contributes to the default perspective.
 |`dataAttributes` |`{ [key: string]: string; }` |yes |Adds data
 attributes to the DOM.
 
-|`insertBefore` |`string | string[]` |yes |Insert this item before the
+|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
 item referenced here. For arrays, the first one found in order is used.
 
-|`insertAfter` |`string | string[]` |yes |Insert this item after the
+|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
 item referenced here. For arrays, the first one found in order is used.
 `insertBefore` takes precedence.
 
@@ -1027,10 +1029,10 @@ to. If not specified, render this item as a top level link.
 |`dataAttributes` |`{ [key: string]: string; }` |yes |Adds data
 attributes to the DOM.
 
-|`insertBefore` |`string | string[]` |yes |Insert this item before the
+|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
 item referenced here. For arrays, the first one found in order is used.
 
-|`insertAfter` |`string | string[]` |yes |Insert this item after the
+|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
 item referenced here. For arrays, the first one found in order is used.
 `insertBefore` takes precedence.
 |===
@@ -1098,7 +1100,7 @@ https://v5.reactrouter.com/
 |`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`
 |no |The component to be rendered when the route matches.
 
-|`path` |`string | string[]` |no |Valid URL path or array of paths that
+|`path` |`string` \| `string[]` |no |Valid URL path or array of paths that
 `path-to-regexp@^1.7.0` understands.
 
 |`perspective` |`string` |yes |The perspective to which this page
@@ -1128,7 +1130,7 @@ https://v5.reactrouter.com/
 |`CodeRef<React.ComponentType<RouteComponentProps<{}, StaticContext, any>>>`
 |no |The component to be rendered when the route matches.
 
-|`path` |`string | string[]` |no |Valid URL path or array of paths that
+|`path` |`string` \| `string[]` |no |Valid URL path or array of paths that
 `path-to-regexp@^1.7.0` understands.
 
 |`exact` |`boolean` |yes |When true, will only match if the path matches
@@ -1635,10 +1637,10 @@ DetailsTab contributes a tab for the topology details panel.
 
 |`label` |`string` |no |The tab label to display in the UI.
 
-|`insertBefore` |`string | string[]` |yes |Insert this item before the
+|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
 item referenced here.For arrays, the first one found in order is used.
 
-|`insertAfter` |`string | string[]` |yes |Insert this item after the
+|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
 item referenced here.For arrays, the first one found in order is
 used.insertBefore takes precedence.
 |===
@@ -1672,12 +1674,12 @@ topology sidebar.SDK component: <Section title=\{}>... padded area
 |no |@deprecated Fallback if no provider is defined. renderNull is a
 no-op already.
 
-|`insertBefore` |`string | string[]` |yes |Insert this item before the
+|`insertBefore` |`string` \| `string[]` |yes |Insert this item before the
 item referenced here.For arrays, the first one found in order is used.
 
-|`insertAfter` |`string | string[]` |yes |Insert this item after the
+|`insertAfter` |`string` \| `string[]` |yes |Insert this item after the
 item referenced here.For arrays, the first one found in order is
-used.insertBefore takes precedence.
+used. The `insertBefore` value takes precedence.
 |===
 
 '''''