Merge pull request #59263 from adellape/dynamicpluginref

Author: adellape

modules/dynamic-plug-in-api.adoc

@@ -1,9 +1,8 @@
 // Module included in the following assemblies:
 //
-// * web_console/dynamic-plug-ins-reference.adoc
+// * web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc
 
-:power-bi-url:
-https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules_typedoc_node_modules_typescript_lib_lib_dom_d_.requestinit.html
+:power-bi-url: https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules_typedoc_node_modules_typescript_lib_lib_dom_d_.requestinit.html
 //needed to add an attribute for the url because escaping the underscore in the link would not work and the build was failing.
 
 :_content-type: REFERENCE
@@ -48,7 +47,7 @@ Component for displaying a green check mark circle icon.
 |Parameter Name |Description
 |`className` |(optional) additional class name for the component
 |`title` |(optional) icon title
-|`size` |(optional) icon size: ('sm', 'md', 'lg', 'xl')
+|`size` |(optional) icon size: (`sm`, `md`, `lg`, `xl`)
 |===
 
 [discrete]
@@ -67,7 +66,7 @@ Component for displaying a red exclamation mark circle icon.
 |Parameter Name |Description
 |`className` |(optional) additional class name for the component
 |`title` |(optional) icon title
-|`size` |(optional) icon size: ('sm', 'md', 'lg', 'xl')
+|`size` |(optional) icon size: (`sm`, `md`, `lg`, `xl`)
 |===
 
 [discrete]
@@ -86,7 +85,7 @@ Component for displaying a yellow triangle exclamation icon.
 |Parameter Name |Description
 |`className` |(optional) additional class name for the component
 |`title` |(optional) icon title
-|`size` |(optional) icon size: ('sm', 'md', 'lg', 'xl')
+|`size` |(optional) icon size: (`sm`, `md`, `lg`, `xl`)
 |===
 
 [discrete]
@@ -219,7 +218,11 @@ Hook that provides information about user access to a given resource. It returns
 [discrete]
 == `useResolvedExtensions`
 
-React hook for consuming Console extensions with resolved `CodeRef` properties. This hook accepts the same argument(s) as `useExtensions` hook and returns an adapted list of extension instances, resolving all code references within each extension's properties. Initially, the hook returns an empty array. Once the resolution is complete, the React component is re-rendered with the hook returning an adapted list of extensions. When the list of matching extensions changes, the resolution is restarted. The hook will continue to return the previous result until the resolution completes. The hook's result elements are guaranteed to be referentially stable across re-renders. It returns a tuple containing a list of adapted extension instances with resolved code references, a boolean flag indicating whether the resolution is complete, and a list of errors detected during the resolution.
+React hook for consuming Console extensions with resolved `CodeRef` properties. This hook accepts the same argument(s) as `useExtensions` hook and returns an adapted list of extension instances, resolving all code references within each extension's properties.
+
+Initially, the hook returns an empty array. After the resolution is complete, the React component is re-rendered with the hook returning an adapted list of extensions. When the list of matching extensions changes, the resolution is restarted. The hook will continue to return the previous result until the resolution completes.
+
+The hook's result elements are guaranteed to be referentially stable across re-renders. It returns a tuple containing a list of adapted extension instances with resolved code references, a boolean flag indicating whether the resolution is complete, and a list of errors detected during the resolution.
 
 .Example
 [source,ts]
@@ -239,7 +242,7 @@ not the extension meets desired type constraints
 [discrete]
 == `HorizontalNav`
 
-A component that creates a Navigation bar for a page.- Routing is handled as part of the component.- `console.tab/horizontalNav` can be used to add additional content to any horizontal nav.
+A component that creates a Navigation bar for a page. Routing is handled as part of the component. `console.tab/horizontalNav` can be used to add additional content to any horizontal navigation.
 
 .Example
 
@@ -331,7 +334,7 @@ const PodRow: React.FC<RowProps<K8sResourceCommon>> = ({ obj, activeColumnIDs })
 [cols=",",options="header",]
 |===
 |Parameter Name |Description
-|`id` |unique id for table
+|`id` |unique ID for table
 |`activeColumnIDs` |active columns
 |`className` |(optional) option class name for styling
 |===
@@ -365,9 +368,9 @@ TableColumns
 namespace column will be included, regardless of column management
 selections
 
-|`\{string} [options.columnManagementID]` |(optional) A unique id
+|`\{string} [options.columnManagementID]` |(optional) A unique ID
 used to persist and retrieve column management selections to and from
-user settings. Usually a 'group~verion~kind' string for a resource.
+user settings. Usually a group/version/kind (GVK) string for a resource.
 |===
 
 A tuple containing the current user selected active columns (a subset of options.columns), and a boolean flag indicating whether user settings have been loaded.
@@ -692,7 +695,7 @@ const Component: React.FC = () => {
 |Parameter Name |Description
 |`groupVersionKind` |group, version, kind of k8s resource
 K8sGroupVersionKind is preferred alternatively can pass reference for
-group, version, kind which is deprecated i.e `group~version~kind` K8sResourceKindReference.
+group, version, kind which is deprecated, i.e, group/version/kind (GVK) K8sResourceKindReference.
 |===
 
 [discrete]
@@ -754,7 +757,7 @@ const Component: React.FC = () => {
 [cols=",",options="header",]
 |===
 |Parameter Name |Description
-|`initResources` |resources need to be watched as key-value pair,
+|`initResources` |Resources must be watched as key-value pair,
 wherein key will be unique to resource and value will be options needed
 to watch for the respective resource.
 |===
@@ -813,12 +816,12 @@ the active cluster the user has selected
 [discrete]
 == `getConsoleRequestHeaders`
 
-A function that creates impersonation and multicluster related headers for API requests using current redux state. it returns an object containing the appropriate impersonation and clustr requst headers, based on redux state.
+A function that creates impersonation and multicluster related headers for API requests using current redux state. It returns an object containing the appropriate impersonation and clustr requst headers, based on redux state.
 
 [cols=",",options="header",]
 |===
 |Parameter Name |Description
-|`targetCluster` |override the current active cluster with the provided
+|`targetCluster` |Override the current active cluster with the provided
 targetCluster
 |===
 
@@ -835,7 +838,7 @@ model. In case of failure, the promise gets rejected with HTTP error response.
 
 |`options.model` |k8s model
 
-|`options.name` |The name of the resource, if not provided then it'll
+|`options.name` |The name of the resource, if not provided then it will
 look for all the resources matching the model.
 
 |`options.ns` | The namespace to look into, should not be specified
@@ -847,7 +850,7 @@ for cluster-scoped resources.
 URL.
 
 |`options.requestInit` |The fetch init object to use. This can have
-request headers, method, redirect, etc. See more link:{power-bi-url}[Interface RequestInit]
+request headers, method, redirect, etc. See link:{power-bi-url}[Interface RequestInit] for more.
 |===
 
 [discrete]
@@ -862,7 +865,7 @@ It creates a resource in the cluster, based on the provided options. It returns
 
 |`options.model` |k8s model
 
-|`options.data` |payload for the resource to be created
+|`options.data` |Payload for the resource to be created
 
 |`options.path` |Appends as subpath if provided
 
@@ -878,16 +881,16 @@ It updates the entire resource in the cluster, based on providedoptions. When a
 [cols=",",options="header",]
 |===
 |Parameter Name |Description
-|`options` |which are passed as key-value pair in the map
+|`options` |Which are passed as key-value pair in the map
 
 |`options.model` | k8s model
 
-|`options.data` |payload for the k8s resource to be updated
+|`options.data` |Payload for the k8s resource to be updated
 
-|`options.ns` |namespace to look into, it should not be specified for
+|`options.ns` |Namespace to look into, it should not be specified for
 cluster-scoped resources.
 
-|`options.name` |resource name to be updated.
+|`options.name` |Resource name to be updated.
 
 |`options.path` | Appends as subpath if provided
 
@@ -899,7 +902,7 @@ URL.
 == `k8sPatchResource`
 
 It patches any resource in the cluster, based on provided options. When a client needs to perform the partial update, they can use
-k8sPatch. Alternatively can use k8sUpdate to replace an existing resource entirely. See more link:https://datatracker.ietf.org/doc/html/rfc6902[Data Tracker]. It returns a promise that resolves to the response of the resource patched. In case of failure promise gets rejected with HTTP error response.
+k8sPatch. Alternatively can use k8sUpdate to replace an existing resource entirely. See link:https://datatracker.ietf.org/doc/html/rfc6902[Data Tracker] for more. It returns a promise that resolves to the response of the resource patched. In case of failure promise gets rejected with HTTP error response.
 
 [cols=",",options="header",]
 |===
@@ -922,7 +925,7 @@ URL.
 [discrete]
 == `k8sDeleteResource`
 
-It deletes resources from the cluster, based on the provided model, resource. The garbage collection works based on 'Foreground'|'Background', can be configured with propagationPolicy property in provided model or passed in json. It returns a promise that resolves to the response of kind Status. In case of failure promise gets rejected with HTTP error response.
+It deletes resources from the cluster, based on the provided model, resource. The garbage collection works based on `Foreground`|`Background` can be configured with propagationPolicy property in provided model or passed in json. It returns a promise that resolves to the response of kind Status. In case of failure promise gets rejected with HTTP error response.
 
 .Example
 `kind: 'DeleteOptions', apiVersion: 'v1', propagationPolicy`
@@ -931,7 +934,7 @@ It deletes resources from the cluster, based on the provided model, resource. Th
 [cols=",",options="header",]
 |===
 |Parameter Name |Description
-|`options` |which are passed as key-value pair in the map.
+|`options` |Which are passed as key-value pair in the map.
 
 |`options.model` | k8s model
 
@@ -943,7 +946,7 @@ It deletes resources from the cluster, based on the provided model, resource. Th
 URL.
 
 |`options.requestInit` |The fetch init object to use. This can have
-request headers, method, redirect, etc. See more link:{power-bi-url}[Interface Request Init]
+request headers, method, redirect, etc. See link:{power-bi-url}[Interface RequestInit] for more.
 
 
 |`options.json` |Can control garbage collection of resources
@@ -966,13 +969,13 @@ Lists the resources as an array in the cluster, based on provided options. It re
 URL and can pass label selector's as well with key "labelSelector".
 
 |`options.requestInit` |The fetch init object to use. This can have
-request headers, method, redirect, etc. See more link:{power-bi-url}[Interface RequestInit]
+request headers, method, redirect, etc. See link:{power-bi-url}[Interface RequestInit] for more.
 |===
 
 [discrete]
 == `k8sListResourceItems`
 
-Same interface as k8sListResource but returns the sub items. It returns the apiVersion for the model i.e `group/version`.
+Same interface as k8sListResource but returns the sub items. It returns the apiVersion for the model, i.e., `group/version`.
 
 [discrete]
 == `getAPIVersionForModel`
@@ -988,7 +991,7 @@ Provides apiVersion for a k8s model.
 [discrete]
 == `getGroupVersionKindForResource`
 
-Provides a group, version, and kind for a resource. It returns the group, version, kind for the provided resource. If the resource does not have an API group, group "core" will be returned.If the resource has an invalid apiVersion then it'll throw Error.
+Provides a group, version, and kind for a resource. It returns the group, version, kind for the provided resource. If the resource does not have an API group, group "core" will be returned. If the resource has an invalid apiVersion, then it will throw an Error.
 
 [cols=",",options="header",]
 |===
@@ -1270,14 +1273,14 @@ section on top of the editor.
 |`onSave` |Callback called when the command CTRL / CMD + S is triggered.
 
 |`ref` |React reference to `{ editor?: IStandaloneCodeEditor }`. Using
-the 'editor' property, you are able to access to all methods to control
+the `editor` property, you are able to access to all methods to control
 the editor.
 |===
 
 [discrete]
 == `ResourceYAMLEditor`
 
-A lazy loaded YAML editor for Kubernetes resources with hover help and completion. The component use the YAMLEditor and add on top of it more functionality likeresource update handling, alerts, save, cancel and reload buttons, accessibility and more. Unless `onSave` callback is provided, the resource update is automatically handled.It should be wrapped in a React.Suspense component.
+A lazy loaded YAML editor for Kubernetes resources with hover help and completion. The component use the YAMLEditor and add on top of it more functionality likeresource update handling, alerts, save, cancel and reload buttons, accessibility and more. Unless `onSave` callback is provided, the resource update is automatically handled.It should be wrapped in a `React.Suspense` component.
 
 .Example
 [source,text]
@@ -1476,7 +1479,7 @@ Creates full page ErrorBoundaryFallbackPage component to display the "Oh no! Som
 [discrete]
 == `PerspectiveContext`
 
-@deprecated - use the provided `usePerspectiveContext` insteadCreates the perspective context.
+Deprecated: Use the provided `usePerspectiveContext` instead. Creates the perspective context.
 
 [cols=",",options="header",]
 |===
@@ -1487,8 +1490,7 @@ Creates full page ErrorBoundaryFallbackPage component to display the "Oh no! Som
 [discrete]
 == `useAccessReviewAllowed`
 
-@deprecated - Use useAccessReview from @console/dynamic-plugin-sdk instead.Hook that provides allowed status about user access to a given
-resource. It returns the `isAllowed` boolean value.
+Deprecated: Use `useAccessReview` from `@console/dynamic-plugin-sdk` instead. Hook that provides allowed status about user access to a given resource. It returns the `isAllowed` boolean value.
 
 [cols=",",options="header",]
 |===
@@ -1500,11 +1502,12 @@ resource. It returns the `isAllowed` boolean value.
 [discrete]
 == `useSafetyFirst`
 
-@deprecated - This hook is not related to console functionality.Hook that ensures a safe asynchronnous setting of React state in case a given
-component could be unmounted. It returns an array with a pair of state value and it's set function.
+Deprecated: This hook is not related to console functionality. Hook that ensures a safe asynchronnous setting of React state in case a given component could be unmounted. It returns an array with a pair of state value and its set function.
 
 [cols=",",options="header",]
 |===
 |Parameter Name |Description
 |`initialState` |initial state value
 |===
+
+:!power-bi-url: