VSD - Add documentation for latest YAML configuration schema
Background
VSD (Value streams dashboard) can be customized using a YAML configuration file, with the migration from a built in VSD page to the shared analytics dashboards framework, existing YAML configuration files will need to be updated to include some additional fields.
To render VSD as a shared analytics dashboard, the group_analytics_dashboard_dynamic_vsd
feature flag needs to be enabled.
Notes
- The updated schema will be introduced behind a feature flag with #414494 (closed)
- The breaking change and dropping support for the old schema will need to occur in %17.0 with #420407 (closed)
Implementation plan
-
Add documentation for the new fields that are required and changes to existing fields -
The data field is renamed to queryOverrides
-
Theid
field is required -
title
field is required -
gridAttributes
must be specified, with fields:yPos
,xPos
,height
,width
-
The visualization field needs to be specified, currently supported fields: dora_chart
,dora_performers_score
,usage_overview
-
-
Provide an example migrating an existing YAML configuration
Edited by Ezekiel Kigbo