From 9384954b5a6d8e9ad36a95602cacc9153685b62b Mon Sep 17 00:00:00 2001 From: Sandra Friesen Date: Tue, 14 Jan 2025 11:29:18 -0800 Subject: [PATCH 1/3] (DOCS-9621) Pulls datastore out to Actions level and reorgs left nav a bit --- config/_default/menus/main.en.yaml | 55 +++++++------- .../datastore/_index.md} | 5 +- .../app_builder/components/_index.md | 72 +++++++++++++++++++ .../app_builder/datastore.md | 6 -- 4 files changed, 106 insertions(+), 32 deletions(-) rename content/en/{service_management/workflows/datastore.md => actions/datastore/_index.md} (97%) delete mode 100644 content/en/service_management/app_builder/datastore.md diff --git a/config/_default/menus/main.en.yaml b/config/_default/menus/main.en.yaml index f255656791571..1fcda62346439 100644 --- a/config/_default/menus/main.en.yaml +++ b/config/_default/menus/main.en.yaml @@ -9,7 +9,7 @@ menu: - name: Service Management identifier: service_management_heading weight: 3000000 - - name: Actions + - name: Actions & Remediations identifier: actions_heading weight: 4000000 - name: Infrastructure @@ -2452,34 +2452,12 @@ menu: parent: case_management identifier: case_management_troubleshooting weight: 3 - - name: Private Actions - url: actions/private_actions/ - pre: server - parent: actions_heading - identifier: private_actions - weight: 10000 - - name: Use Private Actions - url: actions/private_actions/use_private_actions/ - parent: private_actions - identifier: use_private_actions - weight: 101 - - name: Private Action Credentials - url: actions/private_actions/private_action_credentials/ - parent: private_actions - identifier: private_actions_creds - weight: 102 - - name: Actions Catalog - url: actions/actions_catalog/ - pre: books - parent: actions_heading - identifier: actions_catalog - weight: 20000 - name: Workflow Automation url: service_management/workflows/ pre: workflows identifier: workflows parent: actions_heading - weight: 30000 + weight: 10000 - name: Build Workflows url: service_management/workflows/build/ parent: workflows @@ -2555,7 +2533,7 @@ menu: pre: app-builder identifier: app_builder parent: actions_heading - weight: 40000 + weight: 20000 - name: Build Apps url: service_management/app_builder/build/ parent: app_builder @@ -2621,6 +2599,33 @@ menu: parent: app_builder identifier: app_builder_embedded_apps weight: 10 + - name: Datastore + url: actions/datastore/ + pre: server + parent: actions_heading + identifier: datastore + weight: 30000 + - name: Action Catalog + url: actions/actions_catalog/ + pre: books + parent: actions_heading + identifier: action_catalog + weight: 40000 + - name: Private Actions + url: actions/private_actions/ + parent: action_catalog + identifier: private_actions + weight: 1 + - name: Use Private Actions + url: actions/private_actions/use_private_actions/ + parent: private_actions + identifier: use_private_actions + weight: 101 + - name: Private Action Credentials + url: actions/private_actions/private_action_credentials/ + parent: private_actions + identifier: private_actions_creds + weight: 102 - name: Universal Service Monitoring url: universal_service_monitoring/ pre: usm diff --git a/content/en/service_management/workflows/datastore.md b/content/en/actions/datastore/_index.md similarity index 97% rename from content/en/service_management/workflows/datastore.md rename to content/en/actions/datastore/_index.md index 0cf5f8293eb52..7d621edbbcb54 100644 --- a/content/en/service_management/workflows/datastore.md +++ b/content/en/actions/datastore/_index.md @@ -1,6 +1,9 @@ --- -title: Apps Datastore +title: Datastore disable_toc: false +aliases: +- service_management/workflows/datastore/ +- service_management/app_builder/datastore/ further_reading: - link: "service_management/app_builder/build" tag: "Documentation" diff --git a/content/en/service_management/app_builder/components/_index.md b/content/en/service_management/app_builder/components/_index.md index 1b143ce1e78c9..018edf6708492 100644 --- a/content/en/service_management/app_builder/components/_index.md +++ b/content/en/service_management/app_builder/components/_index.md @@ -324,6 +324,78 @@ Displays property and value pairs in JSON format. {{% /collapse-content %}} +{{% collapse-content title="Form" level="h3" %}} +Form input components have the following properties. + +### General + +Title +: The title of the form.
+**Value**: string or expression + +Default value +: The default value that the app populates in the form. To populate a specific field, you can use JSON notation, such as `{"org":"frontend"}` to populate the `org` field with the value `frontend`.
+**Value**: string or expression + +### Fields + +Each item represents a field in the form. Fields each have one of the following types: text input, select, text area, or text. + +Fields have some or all of the following properties depending on their field type: + +Field name +: The name of the key on the form's `value` property this field will be associated with. + +Label +: The label that displays above the field. + +Options +: The options available in a select field. Options must be an array of objects, with a `const` key for the option value and an optional `title` key for the option label.
+You can populate these values using the GUI (default), or toggle **Raw** to use raw JSON input. + +Placeholder text +: The text that displays when no value is entered.
+**Value**: string or expression + +Is Disabled +: Applies disabled styling and removes interactions.
+**Provided values**: on, off + +Is Visible +: Determines whether the field is visible in the form.
+**Provided values**: on, off + +Is Required +: Determines whether the field is required in order to submit the form.
+**Provided values**: on, off + +### Appearance + +Is Visible +: Determines whether the component is visible to the end-user. In edit mode, all components remain visible.
+**Provided values**: on, off + +Is Disabled +: Applies disabled styling and removes interactions.
+**Provided values**: on, off + +### Events + +Event +: **Value**: submit, change, validate + +Reaction +: **Values**: custom, set component state, trigger query, open modal, close modal, download file, set state variable value + +For more information on events, see [Events][1]. + +### Inspect data + +Displays property and value pairs in JSON format. + +{{% /collapse-content %}} + + {{% collapse-content title="JSON input" level="h3" %}} JSON input components have the following properties. diff --git a/content/en/service_management/app_builder/datastore.md b/content/en/service_management/app_builder/datastore.md deleted file mode 100644 index bcc6e8469ae78..0000000000000 --- a/content/en/service_management/app_builder/datastore.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Apps Datastore -disable_toc: false ---- - -{{< include-markdown "service_management/workflows/datastore" >}} \ No newline at end of file From 287c4ed83edfee1141ff34b553ca1bdd89aebbde Mon Sep 17 00:00:00 2001 From: Sandra Friesen Date: Tue, 14 Jan 2025 13:38:49 -0800 Subject: [PATCH 2/3] fix link error --- config/_default/menus/main.en.yaml | 20 +++++--------------- 1 file changed, 5 insertions(+), 15 deletions(-) diff --git a/config/_default/menus/main.en.yaml b/config/_default/menus/main.en.yaml index 1fcda62346439..e641de10d4dcf 100644 --- a/config/_default/menus/main.en.yaml +++ b/config/_default/menus/main.en.yaml @@ -2508,26 +2508,21 @@ menu: parent: workflows identifier: workflows_connections weight: 7 - - name: Datastore - url: service_management/workflows/datastore/ - parent: workflows - identifier: workflows_datastore - weight: 8 - name: Test and Debug url: service_management/workflows/test_and_debug/ parent: workflows identifier: workflows_test_and_debug - weight: 9 + weight: 8 - name: Track Workflows url: service_management/workflows/track parent: workflows identifier: workflows_track - weight: 10 + weight: 9 - name: Limits url: service_management/workflows/limits/ parent: workflows identifier: workflows_limits - weight: 11 + weight: 10 - name: App Builder url: service_management/app_builder/ pre: app-builder @@ -2584,21 +2579,16 @@ menu: parent: app_builder_components identifier: app_builder_tables weight: 702 - - name: Datastore - url: service_management/app_builder/datastore/ - parent: app_builder - identifier: app_builder_datastore - weight: 8 - name: JavaScript Expressions url: service_management/app_builder/expressions/ parent: app_builder identifier: app_builder_expressions - weight: 9 + weight: 8 - name: Embedded Apps url: service_management/app_builder/embedded_apps/ parent: app_builder identifier: app_builder_embedded_apps - weight: 10 + weight: 9 - name: Datastore url: actions/datastore/ pre: server From 918d30d99b011be8a361e85fdd1e0fa99235e4c8 Mon Sep 17 00:00:00 2001 From: Sandra Friesen Date: Tue, 14 Jan 2025 13:41:26 -0800 Subject: [PATCH 3/3] oops --- .../app_builder/components/_index.md | 72 ------------------- 1 file changed, 72 deletions(-) diff --git a/content/en/service_management/app_builder/components/_index.md b/content/en/service_management/app_builder/components/_index.md index 018edf6708492..1b143ce1e78c9 100644 --- a/content/en/service_management/app_builder/components/_index.md +++ b/content/en/service_management/app_builder/components/_index.md @@ -324,78 +324,6 @@ Displays property and value pairs in JSON format. {{% /collapse-content %}} -{{% collapse-content title="Form" level="h3" %}} -Form input components have the following properties. - -### General - -Title -: The title of the form.
-**Value**: string or expression - -Default value -: The default value that the app populates in the form. To populate a specific field, you can use JSON notation, such as `{"org":"frontend"}` to populate the `org` field with the value `frontend`.
-**Value**: string or expression - -### Fields - -Each item represents a field in the form. Fields each have one of the following types: text input, select, text area, or text. - -Fields have some or all of the following properties depending on their field type: - -Field name -: The name of the key on the form's `value` property this field will be associated with. - -Label -: The label that displays above the field. - -Options -: The options available in a select field. Options must be an array of objects, with a `const` key for the option value and an optional `title` key for the option label.
-You can populate these values using the GUI (default), or toggle **Raw** to use raw JSON input. - -Placeholder text -: The text that displays when no value is entered.
-**Value**: string or expression - -Is Disabled -: Applies disabled styling and removes interactions.
-**Provided values**: on, off - -Is Visible -: Determines whether the field is visible in the form.
-**Provided values**: on, off - -Is Required -: Determines whether the field is required in order to submit the form.
-**Provided values**: on, off - -### Appearance - -Is Visible -: Determines whether the component is visible to the end-user. In edit mode, all components remain visible.
-**Provided values**: on, off - -Is Disabled -: Applies disabled styling and removes interactions.
-**Provided values**: on, off - -### Events - -Event -: **Value**: submit, change, validate - -Reaction -: **Values**: custom, set component state, trigger query, open modal, close modal, download file, set state variable value - -For more information on events, see [Events][1]. - -### Inspect data - -Displays property and value pairs in JSON format. - -{{% /collapse-content %}} - - {{% collapse-content title="JSON input" level="h3" %}} JSON input components have the following properties.