From e776937ce6e0be93a620a2a22da62d5712c5915c Mon Sep 17 00:00:00 2001 From: kodjomiles Date: Thu, 14 Aug 2025 12:39:00 +0000 Subject: [PATCH 1/5] Enhance entity page documentation with detailed instructions for adding related entities tabs, including options for relation paths and JSON editing. Added examples for clarity. --- .../page/entity-page.md | 70 ++++++++++++++++++- 1 file changed, 68 insertions(+), 2 deletions(-) diff --git a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md index 8dc1cbcb68..0486ed0ae5 100644 --- a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md +++ b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md @@ -43,9 +43,75 @@ Since we changed direction midway, this relation is **indirect**: When looking at the entity page of a certain `Workflow Run`, the related entities `Deployment Workflow` and `Service` automatically appear, but `Deployment` does not, since its relation is in the other direction. -You can add additional entities to the `Related entities` table by clicking on the `+` button above the table. +### Add a Related entities tab -In the form that appears, the `Related blueprint` dropdown will display all entities that are related in any way to the current entity. In our `Workflow Run` example above, we can use this button to add a `Deployment` tab to our widget. +Click the `+` button above the table to add a custom tab. + +1. Set the tab's `Name` and optional `Description`. + +2. Choose the `Related blueprint` you want to display. + +3. Pick a `Relation path`: + + - **All paths** – includes all available paths from the current blueprint to the target blueprint + - **Specific path** – choose one precise relation chain (multi‑hop is supported) + +4. (Optional) Add `Additional filters` to restrict the result set. + +:::tip Relation path options +Use All paths for a broad overview. Choose a Specific path when multiple paths exist to the same blueprint and you want the tab to reflect exactly one path. +::: + + +#### Filters and Edit JSON + +Selecting `Filters` opens a dialog where you can build conditions using form controls (property, operator, value). +You can switch to a JSON editor using the `Edit JSON` button to define the dataset directly. + +The dataset structure follows this shape: + +```json showLineNumbers +{ + "combinator": "and", + "rules": [ + { + "property": "$title", + "operator": "contains", + "value": "awesome-package" + } + ] +} +``` + + +Use the JSON editor when you need to copy/paste filter sets, keep them in source control, or express conditions that are faster to author as JSON. You can toggle back to the form at any time. + +

Define the tab in JSON mode

+ +You can also toggle `Json Mode` in the Add tab dialog to author the entire tab as JSON. An example: + +```json showLineNumbers +{ + "dataset": { + "combinator": "and", + "rules": [ + { + "property": "$title", + "operator": "contains", + "value": "awesome-package" + } + ] + }, + "title": "custom path package", + "targetBlueprint": "Package", + "relationPath": { + "path": ["service_in_env", "package"], + "fromBlueprint": "service_in_env_deployments" + } +} +``` + +This JSON corresponds to a tab named `custom path package` that targets the `Package` blueprint, follows a specific path from `service_in_env_deployments` via `service_in_env` to `package`, and filters results to titles containing the letter `awesome-package`. #### Show/hide columns From 13c5cbf8d0cd9f901231f974278735ff4999bf66 Mon Sep 17 00:00:00 2001 From: hadar-co Date: Sun, 17 Aug 2025 10:58:47 +0300 Subject: [PATCH 2/5] Update docs/customize-pages-dashboards-and-plugins/page/entity-page.md --- .../page/entity-page.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md index 0486ed0ae5..2092c3be8d 100644 --- a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md +++ b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md @@ -53,8 +53,8 @@ Click the `+` button above the table to add a custom tab. 3. Pick a `Relation path`: - - **All paths** – includes all available paths from the current blueprint to the target blueprint - - **Specific path** – choose one precise relation chain (multi‑hop is supported) + - **All paths** – includes all available paths from the current blueprint to the target blueprint. + - **Specific path** – choose one specific relation chain (multi‑hop is supported). 4. (Optional) Add `Additional filters` to restrict the result set. From f473860adf4be6e41ff54b35f217b0fd119d249b Mon Sep 17 00:00:00 2001 From: hadar-co Date: Sun, 17 Aug 2025 10:58:53 +0300 Subject: [PATCH 3/5] Update docs/customize-pages-dashboards-and-plugins/page/entity-page.md --- docs/customize-pages-dashboards-and-plugins/page/entity-page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md index 2092c3be8d..4ea0d27dbf 100644 --- a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md +++ b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md @@ -59,7 +59,7 @@ Click the `+` button above the table to add a custom tab. 4. (Optional) Add `Additional filters` to restrict the result set. :::tip Relation path options -Use All paths for a broad overview. Choose a Specific path when multiple paths exist to the same blueprint and you want the tab to reflect exactly one path. +Use "all paths" for a broad overview. Choose a specific path when multiple paths exist to the same blueprint and you want the tab to reflect exactly one path. ::: From 9278555fc1761c5b02eef2249aad8ed5a2317334 Mon Sep 17 00:00:00 2001 From: hadar-co Date: Sun, 17 Aug 2025 10:58:58 +0300 Subject: [PATCH 4/5] Update docs/customize-pages-dashboards-and-plugins/page/entity-page.md --- docs/customize-pages-dashboards-and-plugins/page/entity-page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md index 4ea0d27dbf..a8dcd6d191 100644 --- a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md +++ b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md @@ -68,7 +68,7 @@ Use "all paths" for a broad overview. Choose a specific path when multiple paths Selecting `Filters` opens a dialog where you can build conditions using form controls (property, operator, value). You can switch to a JSON editor using the `Edit JSON` button to define the dataset directly. -The dataset structure follows this shape: +The dataset follows this structure: ```json showLineNumbers { From 404c24c5e3907cebd710aa3c5ad22595c4e678d6 Mon Sep 17 00:00:00 2001 From: hadar-co Date: Sun, 17 Aug 2025 10:59:04 +0300 Subject: [PATCH 5/5] Update docs/customize-pages-dashboards-and-plugins/page/entity-page.md --- docs/customize-pages-dashboards-and-plugins/page/entity-page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md index a8dcd6d191..f8319620bf 100644 --- a/docs/customize-pages-dashboards-and-plugins/page/entity-page.md +++ b/docs/customize-pages-dashboards-and-plugins/page/entity-page.md @@ -88,7 +88,7 @@ Use the JSON editor when you need to copy/paste filter sets, keep them in source

Define the tab in JSON mode

-You can also toggle `Json Mode` in the Add tab dialog to author the entire tab as JSON. An example: +You can also toggle `Json Mode` in the "Add tab" dialog to author the entire tab as JSON. An example: ```json showLineNumbers {