Ceph » mgr » Dashboard

Description¶

Currently, Dashboard docs don't display any screenshot of the Dashboard itself, which is a bit contradictory for a piece of software that is essentially visual. Just a search in Google Images will return screenshots of the Dashboard but from other versions (v1) or brandings (SUSE, Red Hat).

The suggestion would be to add screenshots to the following sections:

• Overview: maybe a screenshot of the landing page including top and left navigation bars.
• Accessing the Dashboard, a screenshot of the login screen.
• In the Feature Overview, a screenshots of key page: pools.
• In the Landing Page, a screenshot of the landing page section alone (without navigation bars).
• Enabling Grafana: a screenshot of a Grafana panel (not automatable)
• In the Enabling Prom Alerting: a screenshot of the alerts section (not automatable)
• In the Reporting issues from the Dashboard: a screenshot of the form to report Dashboard issues.

Target persona¶

• Ceph User reading Ceph docs.
• Potential Ceph user looking for pictures of the Dashboard.

Additional Info¶

As a suggestion, this task could be either implemented by manually taking the screenshots, or by leveraging the end-to-end automation framework (Cypress), which features screenshot capabilities.

If the automation approach is chosen, this could also work for visual regression testing. We are already doing Visual Regression Testing with Applitools, so we could both save a local screenshot for the docs and send another to Applitools for testing purposes.