Skip to content

Commit 043e79e

Browse files
grego952grego952
authored
docs: Fix links in the extensibility docs (#3630)
* Fix links in the extensibility docs * Fix remaining links: * Use title case
1 parent 4168cf8 commit 043e79e

File tree

6 files changed

+79
-78
lines changed

6 files changed

+79
-78
lines changed

‎docs/extensibility/20-list-columns.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ You can customize the list page of the user interface component of your resource
66

77
This table lists the available parameters of the **data.list** section in your resource ConfigMap. You can learn whether each of the parameters is required and what purpose it serves.
88

9-
| Parameter | Required | Type | Description |
10-
| ------------------------- | -------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11-
| **source** | **Yes** | string or [JSONata](jsonata.md) expression | It is used to fetch data for the column. In its simplest form, it's the path to the value. |
12-
| **name** | **Yes** | string | Name for the primary label of this field. Required for most widgets (except for some rare cases that don't display a label). This can be a key to use from the [**translation** section](./translations-section.md). |
13-
| **widget** | No | string | A widget used to render the field referred to by the **source** property. By default, the value is displayed verbatim. For more information about the available widgets, see [List and Details Widgets](./50-list-and-details-widgets.md). |
14-
| **valuePreprocessor** | No | string | The name of [value preprocessor](resources.md#value-preprocessors). |
15-
| **sort** | No | boolean | If set to `true`, it allows you to sort the resource list using this value. Defaults to `false`. It can also be set to an object with the following properties: |
16-
| **sort.default** | No | boolean | If the flag is set to `true`, the list view is sorted by this value by default. |
17-
| **sort.compareFunction** | No | [JSONata](jsonata.md) expression | It is required to use `$first` and `$second` variables when comparing two values. There is a special custom function [compareStrings](jsonata.md#comparestringsfirst-second) used to compare two strings, for example, `$compareStrings($first, $second)` |
18-
| **search** | No | boolean | A serach option. If set to `true`, it allows you to search the resource list by this value. Defaults to false. It can also be set to an object with the following property: |
19-
| **search.searchFunction** | No | [JSONata](jsonata.md) expression | It allows you to use `$input` variable to get the search input's value that can be used to search for more complex data. |
9+
| Parameter | Required | Type | Description |
10+
| ------------------------- | -------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| **source** | **Yes** | string or [JSONata](100-jsonata.md) expression | It is used to fetch data for the column. In its simplest form, it's the path to the value. |
12+
| **name** | **Yes** | string | Name for the primary label of this field. Required for most widgets (except for some rare cases that don't display a label). This can be a key to use from the [**translation** section](150-translations.md). |
13+
| **widget** | No | string | A widget used to render the field referred to by the **source** property. By default, the value is displayed verbatim. For more information about the available widgets, see [List and Details Widgets](./50-list-and-details-widgets.md). |
14+
| **valuePreprocessor** | No | string | The name of [value preprocessor](130-additional-sections-resources.md#value-preprocessors). |
15+
| **sort** | No | boolean | If set to `true`, it allows you to sort the resource list using this value. Defaults to `false`. It can also be set to an object with the following properties: |
16+
| **sort.default** | No | boolean | If the flag is set to `true`, the list view is sorted by this value by default. |
17+
| **sort.compareFunction** | No | [JSONata](100-jsonata.md) expression | It is required to use `$first` and `$second` variables when comparing two values. There is a special custom function [compareStrings](101-preset-functions.md#comparestrings-first-second) used to compare two strings, for example, `$compareStrings($first, $second)` |
18+
| **search** | No | boolean | A serach option. If set to `true`, it allows you to search the resource list by this value. Defaults to false. It can also be set to an object with the following property: |
19+
| **search.searchFunction** | No | [JSONata](100-jsonata.md) expression | It allows you to use `$input` variable to get the search input's value that can be used to search for more complex data. |
2020

2121
See the following example:
2222

‎docs/extensibility/30-details-summary.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ In the **data.details** section you can provide configuration of four optional c
1010

1111
This table lists the available parameters of the **data.details.header**, **data.details.status**, **data.details.health** and/or **data.details.body** section in your resource ConfigMap. You can learn whether each of the parameters is required and what purpose it serves. The **data.details.header**, **data.details.health** and **data.details.body** components are arrays of objects. The **data.details.status** component is an object that accepts the **header** and **details** parameters. Within **data.details.status**, the **header** component is an object, and the **body** component is an array of objects.
1212

13-
| Parameter | Required | Type | Description |
14-
| --------------------- | -------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15-
| **source** | **Yes** | string or [JSONata](jsonata.md) expression | Used to fetch data for the widget. In its simplest form, it's the path to the value. Not required for presentational widgets. |
16-
| **name** | **Yes** | string | Name for the primary label of this field. Required for most widgets (except for some rare cases that don't display a label). This can be a key to use from the [**translation** section](./translations-section.md). |
17-
| **widget** | No | string | A widget to render the defined entry. By default the value is displayed verbatim. For more information about the available widgets, see [List and Details Widgets](./50-list-and-details-widgets.md). |
18-
| **valuePreprocessor** | No | string | Name of the [value preprocessor](resources.md#value-preprocessors). |
19-
| **visibility** | No | boolean or [JSONata](jsonata.md) expression | By default all fields are visible; however, you can use the **visibility** property to control a single item display. <br>- If set to `false` explicitly, the field doesn't render. <br> - If set to any string, this property is treated as [JSONata](jsonata.md) format, determining if the field should be visible based on the current value given as `$value`. <br> - If not set, the field always renders. |
20-
| **children** | No | []objects | A list of child widgets used for all `object` and `array` fields. |
13+
| Parameter | Required | Type | Description |
14+
| --------------------- | -------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15+
| **source** | **Yes** | string or [JSONata](100-jsonata.md) expression | Used to fetch data for the widget. In its simplest form, it's the path to the value. Not required for presentational widgets. |
16+
| **name** | **Yes** | string | Name for the primary label of this field. Required for most widgets (except for some rare cases that don't display a label). This can be a key to use from the [**translation** section](150-translations.md |
17+
| ). |
18+
| **widget** | No | string | A widget to render the defined entry. By default the value is displayed verbatim. For more information about the available widgets, see [List and Details Widgets](./50-list-and-details-widgets.md). |
19+
| **valuePreprocessor** | No | string | Name of the [value preprocessor](130-additional-sections-resources.md#value-preprocessors). |
20+
| **visibility** | No | boolean or [JSONata](100-jsonata.md) expression | By default all fields are visible; however, you can use the **visibility** property to control a single item display. <br>- If set to `false` explicitly, the field doesn't render. <br> - If set to any string, this property is treated as [JSONata](100-jsonata.md) format, determining if the field should be visible based on the current value given as `$value`. <br> - If not set, the field always renders. |
21+
| **children** | No | []objects | A list of child widgets used for all `object` and `array` fields. |
2122

2223
Extra parameters might be available for specific widgets.
2324

@@ -174,7 +175,7 @@ This table lists the available parameters of the **data.details.resourceGraph**
174175
| **networkFlowKind** | No | boolean | Determines if the resource should be shown on the network graph. Defaults to `false`, which displays the resource on the structural graph. |
175176
| **networkFlowLevel** | No | integer | Sets the horizontal position of the resource's node on the network graph. |
176177
| **dataSources** | No | []objects | A list of the **dataSources** used in the graph. |
177-
| **dataSources.source** | No | string | The value must correspond to one of the [dataSources](datasources-section.md) names. It selects the related resource and the way it should be matched. |
178+
| **dataSources.source** | No | string | The value must correspond to one of the [dataSources](90-datasources.md) names. It selects the related resource and the way it should be matched. |
178179

179180
See the following examples:
180181

0 commit comments

Comments
 (0)