<!-- Implementation issues are used break-up a large piece of work into small, discrete tasks that can move independently through the build workflow steps. They're typically used to populate a Feature Epic. Once created, an implementation issue is usually refined in order to populate and review the implementation plan and weight. Example workflow: https://about.gitlab.com/handbook/engineering/development/threat-management/planning/diagram.html#plan --> ## Why are we doing this work gitlab~10046106 have been building out the value streams dashboard at the group level this has primarily been through a hard coded vue app that renders a specific set of visualizations, we also support some level of customizable via a YAML config file. At the same time ~"group::product analytics" have built a framework for shared customizable dashboards, initially only for the ~"Category:Product Analytics Visualization", but extending to allow more types of analytics dashboards to be developed. Since this work has occurred in parallel, we are in the current situation where we are maintaining 2 approaches for users to build a customizable Value streams dashboard. We should: - Deprecate the existing built-in value streams dashboard - Move extend the shared analytics dashboards functionality to address any gaps based on gitlab~10046106 requirements The end goal would be to have both Project and Group level Value streams dashboards functionality available only in the shared analytics dashboards. ## Accessing the feature ### Group level * You will need a ~"GitLab Ultimate" license * Enable the `group_analytics_dashboards` feature flag * Navigate to `/groups/<group-id>/-/analytics/dashboards` ### Project level - Moved to https://gitlab.com/groups/gitlab-org/-/epics/13355 * You will need a ~"GitLab Ultimate" license * Enable the `group_analytics_dashboards` feature flag * Navigate to `/<project-id>/-/analytics/dashboards` ### Post release improvements - Moved to https://gitlab.com/groups/gitlab-org/-/epics/13864 ## Relevant links * [Value Streams Dashboard documentation](https://docs.gitlab.com/ee/user/analytics/value_streams_dashboard.html) ## Non-functional requirements <!-- Add details for required items and delete others. --> - [x] Documentation: - [x] Docs changes to deprecate the built in VSD - https://gitlab.com/gitlab-org/gitlab/-/issues/439316+ - [x] Information about the available visualizations - ~~[ ] Information on using the dashboard / visualization designer? (not sure if we'll integrate these anytime soon)~~ - moved to https://gitlab.com/groups/gitlab-org/-/epics/13864 - [x] https://gitlab.com/gitlab-org/gitlab/-/issues/439316+ - [x] Feature flag(s): - [x] [`group_analytics_dashboards`](https://gitlab.com/gitlab-org/gitlab/-/issues/416970) - enable group dashboard listing - [x] [`group_analytics_dashboard_dynamic_vsd`](https://gitlab.com/gitlab-org/gitlab/-/issues/432185) - toggle between built-in and dynamic VSD - Removed in https://gitlab.com/gitlab-org/gitlab/-/merge_requests/151845 - ~~[ ] [`project_analytics_dashboard_dynamic_vsd`](https://gitlab.com/gitlab-org/gitlab/-/issues/431832) - enable project level dynamic VSD (no built-in)~~ - Moved to https://gitlab.com/groups/gitlab-org/-/epics/13355 - [x] [`dora_performers_score`](https://gitlab.com/gitlab-org/gitlab/-/issues/417890) - enables the DORA performers score visualization - [x] Performance: ?? - [x] Testing: ?? ## Implementation plan #### :construction: Extending product analytics to render group VSD * https://gitlab.com/gitlab-org/gitlab/-/issues/424440+ %"16.6" * https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132839+ %"16.6" * ~~https://gitlab.com/gitlab-org/gitlab/-/issues/386842+ %"16.7" * ~~Visually align the builtin VSD with the product analytics dashboard panels~~ %"16.7" --- #### :nail_care_tone4: Visual test improvements + buffer for unknowns * https://gitlab.com/gitlab-org/gitlab/-/issues/386842+ %"16.7" * Visually align the builtin VSD with the product analytics dashboard panels %"16.7" * [CSS visual improvements](https://gitlab.com/gitlab-org/gitlab/-/issues/409947) %"16.7" * https://gitlab.com/gitlab-org/gitlab/-/merge_requests/138451+ %"16.7" * https://gitlab.com/gitlab-org/gitlab/-/issues/433420+ %16.7 * https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137825+ %"16.7" --- #### :on: HAMMERTIME - Enable the feature flag / small fixes :fire: :this-is-fine: :fire_engine: :ambulance: * Test usage overview component / make any outstanding improvements %"16.8" * https://gitlab.com/gitlab-org/gitlab/-/issues/433420+ * Enable the `:group_analytics_dashboards` feature flag for gitlab-org etc %"16.8" * https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141453+ %"16.8" * https://gitlab.com/gitlab-org/gitlab/-/merge_requests/139565+ %"16.8" --- #### :danceduck: :this-is-fine: Default enable feature flag * https://gitlab.com/gitlab-org/gitlab/-/issues/433353+ %"16.9" * https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141539+ %"16.9" * https://gitlab.com/gitlab-org/gitlab/-/issues/417771 %"16.9" * [Add basic dora performers score component](https://gitlab.com/gitlab-org/gitlab/-/issues/421986) %"16.9" * https://gitlab.com/gitlab-org/gitlab/-/issues/439737+ %"16.9" * https://gitlab.com/gitlab-org/gitlab/-/issues/439718+ %"16.10" * Enable the `:group_analytics_dashboard_dynamic_vsd` feature flag for `gitlab-org` %16.11 - https://gitlab.com/gitlab-org/gitlab/-/issues/432185#note_1835337062 * Enable the `:project_analytics_dashboard_dynamic_vsd` feature flag for `gitlab-org` %16.10? - Moved to https://gitlab.com/groups/gitlab-org/-/epics/13355 * Default enable `project_analytics_dashboard_dynamic_vsd` %16.10 / %16.11 ? - Moved to https://gitlab.com/groups/gitlab-org/-/epics/13355 --- #### :boom: :wave_tone4: deprecating the built in VSD * https://gitlab.com/gitlab-org/gitlab/-/issues/439696+ * https://gitlab.com/gitlab-org/gitlab/-/issues/439316+ * https://gitlab.com/gitlab-org/gitlab/-/issues/430320+ * https://gitlab.com/gitlab-org/gitlab/-/issues/410669+ %16.10 * https://gitlab.com/gitlab-org/gitlab/-/issues/414494+ %"16.10" * Take steps to notify / prepare %"16.10" / %"16.11" - https://gitlab.com/gitlab-org/gitlab/-/issues/420407+ * No more built in VSD %"17.0" #### 17.0+ / Post GA * Default enable `project_analytics_dashboard_dynamic_vsd` -> Moved to https://gitlab.com/groups/gitlab-org/-/epics/13355 * https://gitlab.com/gitlab-org/gitlab/-/issues/419766+ * Default enable `group_analytics_dashboard_dynamic_vsd` %"17.0" * https://gitlab.com/gitlab-org/gitlab/-/issues/441206+ ## Definitions of done: 1. On top-level namespace, under `Group > Analyze > Analytics Dashboards`, users can see pre-defined dashboard with 3 panels - "Usage overview", "Comparison panel" and "Performers score panel". 2. On sub-groups under `Group > Analyze > Analytics Dashboards`, users can see pre-defined dashboard with 2 panels - Comparison panel and Performers score panel. 3. On projects under `Project > Analyze > Analytics Dashboards`, users can see pre-defined dashboards with 2 panels - "Comparison panel for the Group" and "Comparison panel for the Project". 4. With the VSD YAML config file, users can custom the: 1. Tiles and description 2. The subgroups and projects to include in the VSD page, 3. Exclude metrics from the panel 4. Filter the "Metrics comparison panel" by labels 5. Filter the "Performers score panel" by project topics. 5. With the VSD YAML config file, users can add multiple dashboards under `Analyze > Analytics Dashboards`. <!-- Workflow and other relevant labels # ~"group::" ~"Category:" gitlab~3207279 Other settings you might want to include when creating the issue. # /assign @ # /epic & --> ## Verification steps <!-- Add verification steps to help GitLab team members test the implementation. This is particularly useful during the MR review and the gitlab~11090870 step. You may not know exactly what the verification steps should be during issue refinement, so you can always come back later to add them. 1. Check-out the corresponding branch 1. ... 1. Profit! -->