Skip to content

Quix-69695: Enhance deployment configuration in pipeline descriptor documentation #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2025
Merged

Quix-69695: Enhance deployment configuration in pipeline descriptor documentation #94

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7fc84a
Enhance deployment configuration in pipeline descriptor documentation
emanuel-quix Oct 21, 2025
14e3d9e
Add default option to embeddedView configuration in pipeline descriptor
emanuel-quix Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions docs/yaml-reference/pipeline-descriptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,15 @@ deployments:
required: true
value: csv-data
plugin:
embeddedView: true
embeddedView:
enabled: true
hideHeader: false
sidebarItem:
show: true
label: Data Visualizer
icon: chart-line
icon: tune
order: 1
badge: Alpha
- name: custom-service
image: custom-repo/my-service:1.2.3
deploymentType: Service
Expand Down Expand Up @@ -137,11 +140,15 @@ deployments:

| Field | Required | Type | Examples | Description & Notes |
|-------|----------|------|----------|---------------------|
| `embeddedView` | No | boolean | `true` | Whether to enable an embedded view for the deployment. |
| `sidebarItem.show` | No | boolean | `true` / `false` | Toggle sidebar visibility. |
| `sidebarItem.label` | No | string | `Data Visualizer` | Display name shown in navigation. |
| `sidebarItem.icon` | No | string | `chart-line`, `database` | Icon identifier (Material/Icon set supported by platform). |
| `sidebarItem.order` | No | integer | `1`, `10` | The display order of the sidebar item (lower numbers appear first). |
| `embeddedView` | No | boolean / object | `true` / `{ enabled: true, hideHeader: false }` | Can be a boolean or object. If `true`, equivalent to `{ enabled: true, hideHeader: false }`. If `false`, embedded view is disabled. |
| `embeddedView.enabled` | No | boolean | `true` / `false` | Enables the embedded view. Default = `false`. |
| `embeddedView.hideHeader` | No | boolean | `true` / `false` | If `true`, hides the header (deployment name + menu). Defaults to `false`. |
| `sidebarItem` | No | object | See nested fields | Optional object configuring the sidebar shortcut in the environment. |
| `sidebarItem.show` | No | boolean | `true` / `false` | Whether to display a shortcut in the sidebar. |
| `sidebarItem.label` | No | string | `Data Visualizer`, `Configuration` | Display name shown in navigation. |
| `sidebarItem.icon` | No | string | `tune`, `chart-line`, `database` | Google Material icon name. |
| `sidebarItem.order` | No | integer | `1`, `10` | Display order (lower numbers appear first). |
| `sidebarItem.badge` | No | string (max 15 chars) | `Alpha`, `Beta`, `New`, `Experimental` | Optional short label displayed next to the sidebar item. |

:material-file-document-outline: See more details in the [Plugin Documentation](../../quix-cloud/managed-services/plugin.md).

Expand Down