-
Epic
-
Resolution: Unresolved
-
Normal
-
None
-
rename-acm-dashboards
-
False
-
None
-
False
-
Not Selected
-
To Do
Epic Goal
Update ACM dashboards name to help Users to easily identify ACM dashboards.
Proposal for naming convention, similar to kubernetes naming convention:
ACM / name_of_dashboard
or
ACM / sub_folder / name_of_dashboard
For example:
ACM / Clusters by Alerts
ACM / Clusters Overview
ACM / Alerts / Alert Analysis
ACM / Alert / Alerts by Cluster
ACM / Resource Optimization / Cluster
ACM / OCP 3.11/ Clusters Overview
ACM / OCP 3.11 / Resource Optimization / Cluster
And dashboard for other operators like CNV can have:
ACM / OpenShift Virtualization / OpenShift Virtualization Overview
Why is this important?
As a user I explored the ACM dashboards in Grafana that had "ACM" prefix and was unaware there were also Alerts dashbords under the "Alerts" folder that were also related.
Having a good naming convention would help users to easily detect the relevant dashboard.
It also follows the same naming convention of the other kubernetes dashboards that exist in Grafana
Scenarios
...
Acceptance Criteria
...
Dependencies (internal and external)
- ...
Previous Work (Optional):
- ...
Open questions:
- …
Done Checklist
- CI - CI is running, tests are automated and merged.
- Release Enablement <link to Feature Enablement Presentation>
- DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
Issue> - DEV - Upstream documentation merged: <link to meaningful PR or GitHub
Issue> - DEV - Downstream build attached to advisory: <link to errata>
- QE - Test plans in Polarion: <link or reference to Polarion>
- QE - Automated tests merged: <link or reference to automated tests>
- DOC - Doc issue opened with a completed template. Separate doc issue
opened for any deprecation, removal, or any current known
issue/troubleshooting removal from the doc, if applicable.