Skip to content

Editing metric dashboard using .yml file

Problem to solve

Customize our metric dashboards require our users to perform the following steps:

  1. Go to the root directory folder
  2. Locate the dashboard.yml file
  3. Update the file
  4. Go back to the dashboard to see changes

we would like to make this experience easier and convenient for our user

Intended users

Proposal

Customize the dashboard using the following steps:

Case 1: User is viewing a system dashboard (e.g. common_metrics.yml)

This dashboard cannot be modified directly by the user, so we offer the possibility to copy it to the repo:

  1. In the dashboard UI the user click on a button to update the dashboard tile
  2. In the backend, we would need to locate and copy the dashboard yml file into the local repository
  3. Then we will redirect the user to the Web IDE for updating .yml
 file
  4. User will update the file & commit

Sub issues:

Case 2: User is viewing a customer dashboard (e.g. .gitlab/dashboards/my_dashboard.yml)

  1. In the dashboard UI the user click on a button to update the dashboard tile
  2. Then we will redirect the user views the .yml file
  3. User will update the file & commit

Sub issues:

Design

Users can edit the dashboard using an "Edit dashboard" button in the filter bar:

Screen_Shot_2019-10-25_at_3.12.45_PM

Documentation

This is the current documentation

Testing

What does success look like, and how can we measure that?

Edited by 🤖 GitLab Bot 🤖