From fe0c95ba1e8f6c25c766dcf812b2765bfcc41bb5 Mon Sep 17 00:00:00 2001 From: Alex Dellapenta Date: Tue, 25 Apr 2023 09:05:25 -0600 Subject: [PATCH] Dynamic plugin ref formatting --- modules/dynamic-plug-in-api.adoc | 75 ++++++------- modules/dynamic-plug-in-sdk-extensions.adoc | 100 +++++++++--------- modules/troubleshooting-dynamic-plug-in.adoc | 2 +- .../dynamic-plug-ins-reference.adoc | 2 +- 4 files changed, 92 insertions(+), 87 deletions(-) diff --git a/modules/dynamic-plug-in-api.adoc b/modules/dynamic-plug-in-api.adoc index 45d7063a08..e193e5ce6c 100644 --- a/modules/dynamic-plug-in-api.adoc +++ b/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> = ({ 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: \ No newline at end of file diff --git a/modules/dynamic-plug-in-sdk-extensions.adoc b/modules/dynamic-plug-in-sdk-extensions.adoc index a387986c62..b1df6c6edc 100644 --- a/modules/dynamic-plug-in-sdk-extensions.adoc +++ b/modules/dynamic-plug-in-sdk-extensions.adoc @@ -1,6 +1,6 @@ // Module is included in the following assemblies: // -// * web_console/dynamic-plug-ins-reference.adoc +// * web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc :_content-type: CONCEPT [id="dynamic-plug-in-sdk-extensions_{context}"] @@ -18,7 +18,9 @@ contributed actions to a particular area of the application. Examples include `topology` and `helm`. |`filter` |`CodeRef<(scope: any, action: Action) => boolean>` |no |A -function that will filter actions based on some conditions. `scope`: The scope +function that will filter actions based on some conditions. + +`scope`: The scope in which actions should be provided for. A hook might be required if you want to remove the `ModifyCount` action from a deployment with a horizontal pod autoscaler (HPA). @@ -226,7 +228,7 @@ utilization query. |`TopConsumerPopovers` |`CodeRef[]>` |yes |Shows -Top consumer popover instead of plain value +Top consumer popover instead of plain value. |=== [discrete] @@ -252,7 +254,7 @@ query. |`TopConsumerPopover` |`CodeRef>` |yes |Shows Top -consumer popover instead of plain value +consumer popover instead of plain value. |=== [discrete] @@ -291,12 +293,12 @@ Ignored for small screens; defaults to `12`. [discrete] == `console.dashboards/custom/overview/detail/item` -Adds an item to the Details card of Overview Dashboard +Adds an item to the Details card of Overview Dashboard. [cols=",,,",options="header",] |=== |Name |Value Type |Optional |Description -|`title` |`string` |no | Details card title. +|`title` |`string` |no | Details card title |`component` |`CodeRef>` |no | The value, rendered by the OverviewDetailItem component @@ -364,7 +366,7 @@ Adds a health subsystem to the status card of Overview dashboard where the sourc |Name |Value Type |Optional |Description |`title` |`string` |no |The display name of the subsystem. -|`queries` |`string[]` |no |The Prometheus queries +|`queries` |`string[]` |no |The Prometheus queries. |`healthHandler` |`CodeRef` |no |Resolve the subsystem's health. @@ -455,7 +457,7 @@ Adds an inventory status group. [cols=",,,",options="header",] |=== |Name |Value Type |Optional |Description -|`id` |`string` |no |The id of the status group. +|`id` |`string` |no |The ID of the status group. |`icon` |`CodeRef>>` @@ -487,7 +489,7 @@ Adds an activity to the Activity Card of Prometheus Overview Dashboard where the [cols=",,,",options="header",] |=== |Name |Value Type |Optional |Description -|`queries` |`string[]` |no |Queries to watch +|`queries` |`string[]` |no |Queries to watch. |`component` |`CodeRef>` |no |The action component. @@ -570,21 +572,21 @@ Gives full control over the web console feature flags with hook handlers. [discrete] == `console.flag/model` -Adds a new web console feature flag driven by the presence of a CRD on the cluster. +Adds a new web console feature flag driven by the presence of a `CustomResourceDefinition` (CRD) object on the cluster. [cols=",,,",options="header",] |=== |Name |Value Type |Optional |Description -|`flag` |`string` |no |The name of the flag to set once the CRD is detected. +|`flag` |`string` |no |The name of the flag to set after the CRD is detected. |`model` |`ExtensionK8sModel` |no |The model which refers to a -`CustomResourceDefinition`. +CRD. |=== [discrete] == `console.global-config` -This extension identifies a resource used to manage the configuration of the cluster.
A link to the resource will be added to the Administration - Cluster Settings - Configuration page. +This extension identifies a resource used to manage the configuration of the cluster. A link to the resource will be added to the *Administration* -> *Cluster Settings* -> *Configuration* page. [cols=",,,",options="header",] |=== @@ -639,7 +641,7 @@ This extension can be used to contribute a navigation item that points to a spec |`name` |`string` |no |The name of this item. -|`href` |`string` |no |The link href value. +|`href` |`string` |no |The link `href` value. |`perspective` |`string` |yes |The perspective ID to which this item belongs to. If not specified, contributes to the default perspective. @@ -662,7 +664,7 @@ item referenced here. For arrays, the first one found in order is used. |`namespaced` |`boolean` |yes |If `true`, adds `/ns/active-namespace` to the end. -|`prefixNamespaced` |`boolean` |yes |If `true`, adds `/k8s/ns/active-namespace` to the beginning +|`prefixNamespaced` |`boolean` |yes |If `true`, adds `/k8s/ns/active-namespace` to the beginning. |=== [discrete] @@ -865,7 +867,7 @@ the `location.pathname` exactly. [discrete] == `console.perspective` -This extension contributes a new perspective to the console which enables customization of the navigation menu. +This extension contributes a new perspective to the console, which enables customization of the navigation menu. [cols=",,,",options="header",] |=== @@ -1008,13 +1010,13 @@ function, operating on the reducer-managed substate. [discrete] == `console.resource/create` -This extension allows plugins to provide a custom component (ie wizard or form) for specific resources, which will be rendered, when users try to create a new resource instance. +This extension allows plugins to provide a custom component (i.e., wizard or form) for specific resources, which will be rendered, when users try to create a new resource instance. [cols=",,,",options="header",] |=== |Name |Value Type |Optional |Description |`model` |`ExtensionK8sModel` |no |The model for which this create -resource page will be rendered. +resource page will be rendered |`component` |`CodeRef>` |no |The @@ -1060,12 +1062,12 @@ Adds a tab to a horizontal nav matching the `contextId`. [cols=",,,",options="header",] |=== |Name |Value Type |Optional |Description -|`contextId` |`string` |no | Context ID assigned to the horizontal nav in which the tab will be injected. Possible values:`dev-console-observe` +|`contextId` |`string` |no | Context ID assigned to the horizontal nav in which the tab will be injected. Possible values: `dev-console-observe` |`name` |`string` |no | The display label of the tab -|`href` |`string` |no | The href appended to the existing URL +|`href` |`string` |no | The `href` appended to the existing URL |`component` |`CodeRef>>` @@ -1113,7 +1115,7 @@ events |Name |Value Type |Optional |Description |`adapt` |`CodeRef<(element: GraphElement) => AdapterDataType \| undefined>` -|no |adapter to adapt element to data that can be used by Build component. +|no |Adapter to adapt element to data that can be used by Build component. |=== [discrete] @@ -1125,8 +1127,8 @@ events |=== |Name |Value Type |Optional |Description |`adapt` -|`CodeRef<(element: GraphElement) => NetworkAdapterType | undefined>` -|no |adapter to adapt element to data that can be used by Networking component. +|`CodeRef<(element: GraphElement) => NetworkAdapterType \| undefined>` +|no |Adapter to adapt element to data that can be used by Networking component. |=== [discrete] @@ -1139,7 +1141,7 @@ events |Name |Value Type |Optional |Description |`adapt` |`CodeRef<(element: GraphElement) => AdapterDataType \| undefined>` -|no | adapter to adapt element to data that can be used by Pod component. | +|no |Adapter to adapt element to data that can be used by Pod component. | |=== [discrete] @@ -1178,7 +1180,7 @@ Topology Data Model Factory Extension |`priority` |`number` |no |Priority for the factory |`resources` |`WatchK8sResourcesGeneric` |yes |Resources to be fetched -from useK8sWatchResources hook. +from `useK8sWatchResources` hook. |`workloadKeys` |`string[]` |yes |Keys in resources containing workloads. @@ -1201,10 +1203,10 @@ Topology Decorator Provider Extension [cols=",,,",options="header",] |=== |Name |Value Type |Optional |Description -|`id` |`string` |no |id for topology decorator specific to the extension -|`priority` |`number` |no |priority for topology decorator specific to the extension -|`quadrant` |`TopologyQuadrant` |no | quadrant for topology decorator specific to the extension -|`decorator` |`CodeRef` |no |decorator specific to the extension | +|`id` |`string` |no |ID for topology decorator specific to the extension +|`priority` |`number` |no |Priority for topology decorator specific to the extension +|`quadrant` |`TopologyQuadrant` |no |Quadrant for topology decorator specific to the extension +|`decorator` |`CodeRef` |no |Decorator specific to the extension | |=== [discrete] @@ -1219,7 +1221,7 @@ Topology Decorator Provider Extension alert should not be shown after dismissed. |`contentProvider` -|`CodeRef<(element: GraphElement) => DetailsResourceAlertContent | null>` +|`CodeRef<(element: GraphElement) => DetailsResourceAlertContent \| null>` |no |Hook to return the contents of the alert. |=== @@ -1272,18 +1274,18 @@ used. The `insertBefore` value takes precedence. contribute to. |`provider` |`CodeRef` |no |A hook that -returns a component, or if null or undefined renders in the -topology sidebar.SDK component:
... padded area +returns a component, or if null or undefined, renders in the +topology sidebar. SDK component: `
...` padded area |`section`|`CodeRef<(element: GraphElement, renderNull?: () => null) => React.Component \| undefined>` -|no |@deprecated Fallback if no provider is defined. renderNull is a +|no |Deprecated: Fallback if no provider is defined. renderNull is a no-op already. |`insertBefore` |`string` \| `string[]` |yes |Insert this item before the -item referenced here.For arrays, the first one found in order is used. +item referenced here. For arrays, the first one found in order is used. |`insertAfter` |`string` \| `string[]` |yes |Insert this item after the -item referenced here.For arrays, the first one found in order is +item referenced here. For arrays, the first one found in order is used. The `insertBefore` value takes precedence. |=== @@ -1307,10 +1309,10 @@ Topology relationship provider connector extension [cols=",,,",options="header",] |=== |Name |Value Type |Optional |Description -|`provides` |`CodeRef` |no |use to determine if a connection can be created between the source and target node -|`tooltip` |`string` |no | tooltip to show when connector operation is hovering over the drop target ex: "Create a Visual Connector" -|`create` |`CodeRef` |no | callback to execute when connector is drop over target node to create a connection -|`priority` |`number` |no |priority for relationship, higher will be preferred in case of multiple +|`provides` |`CodeRef` |no |Use to determine if a connection can be created between the source and target node +|`tooltip` |`string` |no |Tooltip to show when connector operation is hovering over the drop target, for example, "Create a Visual Connector" +|`create` |`CodeRef` |no |Callback to execute when connector is drop over target node to create a connection +|`priority` |`number` |no |Priority for relationship, higher will be preferred in case of multiple |=== [discrete] @@ -1341,17 +1343,17 @@ This extension can be used to add an item to the user preferences group on the c |=== |Name |Value Type |Optional |Description |`id` |`string` |no |ID used to identify the user preference item and -referenced in insertAfter and insertBefore to define the item order. +referenced in insertAfter and insertBefore to define the item order |`label` |`string` |no |The label of the user preference -|`description` |`string` |no |The description of the user preference. +|`description` |`string` |no |The description of the user preference |`field` |`UserPreferenceField` |no |The input field options used to -render the values to set the user preference. +render the values to set the user preference |`groupId` |`string` |yes |IDs used to identify the user preference -groups the item would belong to. +groups the item would belong to |`insertBefore` |`string` |yes |ID of user preference item before which this item should be placed @@ -1386,11 +1388,11 @@ This extension allows plugins to contribute an add action item to the add page o |Name |Value Type |Optional |Description |`id` |`string` |no |ID used to identify the action. -|`label` |`string` |no |The label of the action +|`label` |`string` |no |The label of the action. |`description` |`string` |no |The description of the action. -|`href` |`string` |no |The href to navigate to. +|`href` |`string` |no |The `href` to navigate to. |`groupId` |`string` |yes |IDs used to identify the action groups the action would belong to. @@ -1404,12 +1406,12 @@ access review to control the visibility or enablement of the action. [discrete] == `dev-console.add/action-group` -This extension allows plugins to contibute a group in the add page of developer console.
Groups can be referenced by actions, which will be grouped together in the add action page based on their extension definition.
For example, a Serverless plugin can contribute a Serverless group and together with multiple add actions. +This extension allows plugins to contibute a group in the add page of developer console. Groups can be referenced by actions, which will be grouped together in the add action page based on their extension definition. For example, a Serverless plugin can contribute a Serverless group and together with multiple add actions. [cols=",,,",options="header",] |=== |Name |Value Type |Optional |Description -|`id` |`string` |no |ID used to identify the action group. +|`id` |`string` |no |ID used to identify the action group |`name` |`string` |no |The title of the action group @@ -1423,7 +1425,7 @@ should be placed [discrete] == `dev-console.import/environment` -This extension can be used to specify extra build environment variable fields under the builder image selector in the dev console git import form. When set, the fields will override environment variables of the same name in the build section. +This extension can be used to specify extra build environment variable fields under the builder image selector in the developer console git import form. When set, the fields will override environment variables of the same name in the build section. [cols=",,,",options="header",] |=== @@ -1465,7 +1467,7 @@ resource page links to. |`name` |`string` |no |The name of the tab. -|`href` |`string` |yes |The optional href for the tab link. If not +|`href` |`string` |yes |The optional `href` for the tab link. If not provided, the first `path` is used. |`exact` |`boolean` |yes |When true, will only match if the path matches diff --git a/modules/troubleshooting-dynamic-plug-in.adoc b/modules/troubleshooting-dynamic-plug-in.adoc index f802b2deb0..50dff5d955 100644 --- a/modules/troubleshooting-dynamic-plug-in.adoc +++ b/modules/troubleshooting-dynamic-plug-in.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * web_console/dynamic-plug-ins-reference.adoc +// * web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc :_content-type: REFERENCE [id="troubleshooting-dynamic-plug-in_{context}"] diff --git a/web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc b/web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc index ab5617c40b..0fcd0b4f45 100644 --- a/web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc +++ b/web_console/dynamic-plug-in/dynamic-plug-ins-reference.adoc @@ -16,4 +16,4 @@ include::modules/troubleshooting-dynamic-plug-in.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -xref:../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates] +* xref:../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates]