Editing metric dashboard using .yml file
Problem to solve
Customize our metric dashboards require our users to perform the following steps:
- Go to the root directory folder
- Locate the dashboard.yml file
- Update the file
- 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:
common_metrics.yml
)
Case 1: User is viewing a system dashboard (e.g. This dashboard cannot be modified directly by the user, so we offer the possibility to copy it to the repo:
- In the dashboard UI the user click on a button to update the dashboard tile
- In the
backend
, we would need to locate and copy the dashboard yml file into the local repository - Then we will redirect the user to the Web IDE for updating .yml file
- User will update the file & commit
Sub issues:
-
frontend
PENDING
- backend #35228 (closed)
.gitlab/dashboards/my_dashboard.yml
)
Case 2: User is viewing a customer dashboard (e.g. - In the dashboard UI the user click on a button to update the dashboard tile
- Then we will redirect the user views the .yml file
- User will update the file & commit
Sub issues:
Design
Users can edit the dashboard using an "Edit dashboard" button in the filter bar:
Documentation
This is the current documentation
Testing
What does success look like, and how can we measure that?
Edited by 🤖 GitLab Bot 🤖