Skip to content

Update visualization designer to save configs to file

Tim Zallmann requested to merge tz-save-visualization into master

What does this MR do and why?

This MR updates the groupproduct analytics visualization designer with the ability to save new visualizations to files and it redirects the user back to their original dashboard if they clicked on Create a new visualization from the dashboard edit view.

This MR does not:

  • Users to edit existing visualizations. To be done in a future TBA issue.

Known issues:

Related issue: Save Visualization to file (#385700 - closed)

Screenshots or screen recordings

User clicks on Visualization designer + validation

Note: Editing existing visualizations is not yet supported. We're leaving the user on the visualization they just edited, but in the future users should be able to edit after saving it or be given the option to add it to a new dashboard.

Kapture_2023-06-19_at_12.05.20

User clicks Create a new visualization from a custom dashboard

Note: Known issue with visualization list. [Dashboard designer] Fetch available visualisat... (#414281 - closed)

Kapture_2023-06-19_at_12.03.36

User clicks Create a new visualziation from a new dashboard

Note: On new dashboards the available visualization list loads because this is using the deprecated snowplow logic.

Kapture_2023-06-19_at_12.02.16

How to set up and validate locally

  1. Make sure you are on GitLab Ultimate
  2. Follow these instructions to set up Product Analytics in your GDK.
    • Import to also enable both the product_analytics_snowplow_support and combined_analytics_dashboards_editor feature flags.
  3. Create a new project with an empty repository.
  4. Enable custom dashboards at Project > Settings > Analytics and pick the empty project.
  5. Create a custom dashboard by following these instructions.
  6. Create a visualisation from the following origins:
    • Project > Settings > Analytics and then clicking on Visualziation Designer button.
    • Project > Settings > Analytics and then clicking on New dashboard and then Create a new visualization.
    • Project > Settings > Analytics > Your custom dashboard and then clicking on Edit and then Create a new visualization.
  7. Verify in your custom dashboard project repository that the visualization files have been created in .gitlab/analytics/dashboards/visualizations/.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

closes #385700 (closed)

Edited by Jiaan Louw

Merge request reports