Clarify terminology for Insights

As a user, I find the UI text on the Insights page confusing, as I customize a report or chart, select a page, and view a dashboard. The Insights docs also use various terms to refer to the features.

From my understanding, there are two "parts" of Insights:

  • Configuration file (report, page, chart)
  • Data visualization, displayed on the Insights page (dashboard, bar chart)

On the Insights page, we use different terms to refer to these concepts:

  • Report ("Configure a custom report...")
  • Page ("Select Page" dropdown list)
  • Dashboard ("MR dashboard", "Bugs dashboard" etc.)

From the Insights docs example, I understand:

  • A Page is the configuration of a Dashboard, which consists of one or more charts/data visualizations.
  • A Chart is the configuration of a data visualization (bar/line/...). The configuration bugsChart is displayed as "Bugs dashboard".
  • A Report is ...? This term isn't used in the docs.

Proposal

  1. On the Insights page change the UI text of:

    • The dropdown list, from "Select Page" to "Select dashboard".
    • The intro, from "Configure a custom report" to "Configure a page/chart".

  2. On the Insights docs, add definitions for the components of Insights.

Related MRs

  • !98407 (merged) adds documentation on how to interact with Insights charts/dashboards