diff --git a/docs/configurations/index.md b/docs/configurations/index.md index a1b6a0d4a..5bcf72f73 100644 --- a/docs/configurations/index.md +++ b/docs/configurations/index.md @@ -5,29 +5,29 @@ proxy configuration, and logging level configuration. ### Configuration Properties | Property | Type | Description | -|-------------------------------------------------------------------| ------ | ------------------------------------------------------- | +|-------------------------------------------------------------------|--------|---------------------------------------------------------| | title\* | string | - | | description | string | To provide a brief summary of an configuration page. | -| [subDescription](../advanced/sub_description) | object | To provide broader description of an configuration page | +| [subDescription](../advanced/sub_description.md) | object | To provide broader description of an configuration page | | [tabs](#tabs-properties)\* | array | To specify a list of tab. | ### Tabs properties -| Property | Type | Description | -|--------------------------------------------------------------| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| name\* | string | To define the particular tab name. | -| title\* | string | To show the title of the tab. | -| [entity](../entity)\* | array | A list of fields and their properties. | -| [table](../table) | object | To display accounts stanza in table | -| style | string | By specifying this property in the global config file, the forms can either be opened as a new page or in a dialog.
Supported values are "page" or "dialog".
Default value is **dialog**. | -| options | object | This property allows you to enable the [saveValidator](../advanced/save_validator) feature. | -| hook | object | It is used to add custom behaviour to forms. Visit the [Custom Hook](../custom_ui_extensions/custom_hook) page to learn more. | -| [warning](../advanced/custom_warning.md) | object | It is used to add custom warning message for each of modes ('create', 'edit', 'config', 'clone'), message is displayed on form | -| conf | string | TBD | -| restHandlerName | string | TBD | -| restHandlerModule | string | TBD | -| restHandlerClass | string | TBD | -| customTab | Object | This property allows you to enable the [custom tab](../custom_ui_extensions/custom_tab) feature. | +| Property | Type | Description | +|-----------------------------------------------------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name\* | string | To define the particular tab name. | +| title\* | string | To show the title of the tab. | +| [entity](../entity/index.md)\* | array | A list of fields and their properties. | +| [table](../table.md) | object | To display accounts stanza in table | +| style | string | By specifying this property in the global config file, the forms can either be opened as a new page or in a dialog.
Supported values are "page" or "dialog".
Default value is **dialog**. | +| options | object | This property allows you to enable the [saveValidator](../advanced/save_validator.md) feature. | +| hook | object | It is used to add custom behaviour to forms. Visit the [Custom Hook](../custom_ui_extensions/custom_hook.md) page to learn more. | +| [warning](../advanced/custom_warning.md) | object | It is used to add custom warning message for each of modes ('create', 'edit', 'config', 'clone'), message is displayed on form | +| conf | string | TBD | +| restHandlerName | string | TBD | +| restHandlerModule | string | TBD | +| restHandlerClass | string | TBD | +| customTab | Object | This property allows you to enable the [custom tab](../custom_ui_extensions/custom_tab.md) feature. | ### Usage diff --git a/docs/entity/components.md b/docs/entity/components.md index 893e80534..fe44f4533 100644 --- a/docs/entity/components.md +++ b/docs/entity/components.md @@ -452,7 +452,7 @@ It supports files that can be opened in text mode or with a text editor, which a It only sends file content to the server by reading it using the [readAsArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsArrayBuffer) method of the FileReader class, and then decoding it into **UTF-8** format, using the [decode](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder/decode) method of the TextDecoder class. -The file content can be validated using in-built validators such as [string](../validators/#string) and [regex](../validators/#regex), and a custom validator can also be implemented using a [custom hook](../../custom_ui_extensions/custom_hook) and [saveValidator](../advanced/save_validator). +The file content can be validated using in-built validators such as [string](validators.md#string) and [regex](validators.md#regex), and a custom validator can also be implemented using a [custom hook](../custom_ui_extensions/custom_hook.md) and [saveValidator](../advanced/save_validator.md). This feature allows you to upload a single file. diff --git a/docs/entity/index.md b/docs/entity/index.md index c81cfcff4..1063a4692 100644 --- a/docs/entity/index.md +++ b/docs/entity/index.md @@ -4,19 +4,19 @@ title: Entity ## Entity Properties -| Property | Type | Description | Default Value | -|---------------------------------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| -| field\* | string | To define a particular entity field. | - | -| label\* | string | It represents a caption for a field in a user interface. | - | -| [type](./components)\* | string | To specify the type of entity to be rendered in inputs or configuration form. | - | -| help | string | Help text gives context about a fields input, such as how the input will be used. It is displayed directly below an input field. | - | -| tooltip | string | Displays a tooltip beside the label. | - | -| defaultValue | string, number or boolean | The initial input value. | - | -| [options](#common-options) | object | To specify an additional attribute for a particular type of entity, such as `items` for a radio bar. | - | -| required | boolean | To specify whether the field is required or not. | false | -| encrypted | boolean | To encrypt that particular field. | false | -| [validators](./validators) | array | It is used to validate the values of fields using various validators. | - | -| [modifyFieldsOnValue](./modifyFieldsOnValue) | array | It is used to speficy values and parameters that will influence visually other entities. | - | +| Property | Type | Description | Default Value | +|------------------------------------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| field\* | string | To define a particular entity field. | - | +| label\* | string | It represents a caption for a field in a user interface. | - | +| [type](./components.md)\* | string | To specify the type of entity to be rendered in inputs or configuration form. | - | +| help | string | Help text gives context about a fields input, such as how the input will be used. It is displayed directly below an input field. | - | +| tooltip | string | Displays a tooltip beside the label. | - | +| defaultValue | string, number or boolean | The initial input value. | - | +| [options](#common-options) | object | To specify an additional attribute for a particular type of entity, such as `items` for a radio bar. | - | +| required | boolean | To specify whether the field is required or not. | false | +| encrypted | boolean | To encrypt that particular field. | false | +| [validators](./validators.md) | array | It is used to validate the values of fields using various validators. | - | +| [modifyFieldsOnValue](./modifyFieldsOnValue.md) | array | It is used to speficy values and parameters that will influence visually other entities. | - | > [!WARNING] > The [Placeholder](https://splunkui.splunk.com/Packages/react-ui/Text?section=develop) attribute is deprecated and will be removed in the next major version. diff --git a/docs/inputs/index.md b/docs/inputs/index.md index 2db387122..e3d1ccf6d 100644 --- a/docs/inputs/index.md +++ b/docs/inputs/index.md @@ -4,37 +4,38 @@ title: Inputs The input page stores configuration information for data collection. Multiple inputs can be created on the Inputs page. -Developers are required to add services in the global config file to create a new Input. If multiple services are provided, a dropdown field will appear on the Inputs page. In contrast, a button will be displayed for a single service. +Developers are required to add services in the global config file to create a new Input. If multiple services are +provided, a dropdown field will appear on the Inputs page. In contrast, a button will be displayed for a single service. ### Properties -| Property | Type | Description | -| ------------------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------- | -| title\* | string | - | +| Property | Type | Description | +|---------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------------------| +| title\* | string | - | | description | string | It provides a brief summary of an inputs page. | +| [subDescription](../advanced/sub_description.md) | object | It provides broader description of an inputs page. | | menu | object | This property allows you to enable the [custom menu].(../custom_ui_extensions/custom_menu.md) feature. | -| [table](../table) | object | It displays input stanzas in a tabular format. | -| groupsMenu | array | This property allows you to enable the [multi-level menu](./multilevel_menu.md) feature. | -| [services](#services-properties)\* | array | It specifies a list of modular inputs. | +| [table](../table.md) | object | It displays input stanzas in a tabular format. | +| groupsMenu | array | This property allows you to enable the [multi-level menu](./multilevel_menu.md) feature. | +| [services](#services-properties)\* | array | It specifies a list of modular inputs. | ### Services Properties -| Property | Type | Description | -| ------------------------------------------------------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| name\* | string | It defines the particular service name. | -| title\* | string | It shows the title of the service. | -| subTitle | string | It shows the subtitle (or additional information) of the service. | -| [entity](../entity)\* | array | It is a list of fields and their properties. | -| [groups](../advanced/groups_feature) | array | It is used to divide forms into distinct sections, each comprising relevant fields. | -| style | string | By specifying this property in the global configuration file, the forms can either be opened as a new page or in a dialog.
Supported values are "page" or "dialog".
The default value is **dialog**. | -| options | object | This property allows you to enable the [saveValidator](../advanced/save_validator) feature. | -| hook | object | It is used to add custom behaviour to forms. Visit the [Custom Hook](../custom_ui_extensions/custom_hook) page to learn more. | -| [warning](../advanced/custom_warning.md) | object | It is used to add the custom warning message for each of the modes of 'create', 'edit', 'config', and 'clone'. The message is displayed on the form. | -| [subDescription](../advanced/sub_description) | object | It provides broader description of an inputs page. | -| conf | string | TBD | -| restHandlerName | string | TBD | -| restHandlerModule | string | TBD | -| restHandlerClass | string | TBD | +| Property | Type | Description | +|-----------------------------------------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name\* | string | It defines the particular service name. | +| title\* | string | It shows the title of the service. | +| subTitle | string | It shows the subtitle (or additional information) of the service. | +| [entity](../entity/index.md)\* | array | It is a list of fields and their properties. | +| [groups](../advanced/groups_feature.md) | array | It is used to divide forms into distinct sections, each comprising relevant fields. | +| style | string | By specifying this property in the global configuration file, the forms can either be opened as a new page or in a dialog.
Supported values are "page" or "dialog".
The default value is **dialog**. | +| options | object | This property allows you to enable the [saveValidator](../advanced/save_validator.md) feature. | +| hook | object | It is used to add custom behaviour to forms. Visit the [Custom Hook](../custom_ui_extensions/custom_hook.md) page to learn more. | +| [warning](../advanced/custom_warning.md) | object | It is used to add the custom warning message for each of the modes of 'create', 'edit', 'config', and 'clone'. The message is displayed on the form. | +| conf | string | TBD | +| restHandlerName | string | TBD | +| restHandlerModule | string | TBD | +| restHandlerClass | string | TBD | ### Usage diff --git a/docs/inputs/multilevel_menu.md b/docs/inputs/multilevel_menu.md index 4da0e7890..db1a2bde9 100644 --- a/docs/inputs/multilevel_menu.md +++ b/docs/inputs/multilevel_menu.md @@ -1,6 +1,6 @@ This feature allows us to organize the input services into different categories. As a result, each group/category will have a separate sub-menu that can include numerous types of input services. Inputs services can also belong to multiple groups/categories. -Using the [Custom Hook](../../custom_ui_extensions/custom_hook), `groupName` can be saved in any form field for a specific inputs service stanza. +Using the [Custom Hook](../custom_ui_extensions/custom_hook.md), `groupName` can be saved in any form field for a specific inputs service stanza. > `Tabs` and `Multi-level menu` feature cannot be used together. diff --git a/docs/inputs/tabs.md b/docs/inputs/tabs.md index 14dee8dfd..fe74d9a8d 100644 --- a/docs/inputs/tabs.md +++ b/docs/inputs/tabs.md @@ -62,7 +62,7 @@ If `title` and `description` are provided in the global configuration file, then > > When using the Tabs feature, if the `table` or `description` property is provided in the `inputs`, the error ```instance.pages.inputs is not one of [subschema 0], [subschema 1]``` will be displayed. > -> [Custom Menu](../../custom_ui_extensions/custom_menu/) is not supported with the tabs feature. +> [Custom Menu](../custom_ui_extensions/custom_menu.md) is not supported with the tabs feature. ### Output diff --git a/mkdocs.yml b/mkdocs.yml index 3daec9aff..0e82d21ae 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -38,6 +38,7 @@ nav: - Multi-level Menu: "inputs/multilevel_menu.md" - Configuration: - "configurations/index.md" + - Introduction: "configurations/index.md" - Proxy: "configurations/proxy.md" - Dashboard: "dashboard.md" - Entity: