Insights page should provide documentation on how to configure it
Problem to solve
When you first land on the Insights page and have not yet configured it, (example) there is no information regarding what you should use this page for or that you can customize it. It looks like when this page is empty, there might be a banner shown that points you to configure it, but because we have a default Issues and Merge Request dashboard, you are left thinking this is all there is to offer.
Solution
- Adding a description (line of text) under the Insight page title, so that people understand how to use it and what value it can provide.
- Add link to the documentation.
- Text:
Configure a custom report for insights into your group processes such as amount of issues, bugs, and merge requests per month. How do I configure an insights report?
Screenshot | Note |
---|---|
Screenshot created by copying the markup and styles from Analytics > Code review. It is provided as an example rather than as an implementation guide |
Implementation plan
-
Update the insights.vue component to include description text -
The text should read Configure a custom report for insights into your group processes such as amount of issues, bugs, and merge requests per month. How do I configure an insights report?
-
The text: How do I configure an insights report?
should link to https://docs.gitlab.com/ee/user/group/insights/#configure-your-insights
This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.