Feature Overview (aka. Goal Summary)

This feature aims to empower platform engineers to configure and manage Key Performance Indicators (KPIs) and integrate Scorecard data from various sources within the Red Hat Developer Hub (RHDH) platform. This will provide developers with personalized and role-based access to crucial project metrics and performance insights. The initial version will release as a developer preview.

Goals:

• Configurable KPIs: Allow platform engineers to easily create, configure, and group KPIs using YAML files, enabling organized and persona-specific information display.

• Data Source Integration: Enhance Scorecard functionality by reusing existing RHDH/Backstage.io integrations (e.g., Jira, Git) to generate project metrics.

• Role-Based Access: Provide developers with immediate and role-tailored access to relevant KPIs upon logging into RHDH, leveraging Role-Based Access Control (RBAC).

Requirements:

• Platform engineers must be able to create and group KPIs, defining data sources and thresholds via YAML configuration.
• The system must securely handle authentication with integrated services (starting with Jira and GitHub) using existing RHDH authentication mechanisms.
• RBAC must be implemented to manage KPI access and display based on user roles.
• KPIs and Scorecard data should be rendered on designated RHDH pages (e.g., homepage, entity overview).
• The initial 1.8 goal is to display a single metric with basic threshold-based coloring.
• The scorecard will initially be implemented without database persistence, calculating scores on the fly when an entity card is viewed.
• The scorecard plugin will be built from scratch and integrate directly with Backstage.
• The scorecard plugin will depend on the installation of relevant data source plugins (e.g., Jira, GitHub), but not have a hard dependency on any of them, as each customer environment will be unique.
• Customization will initially be defined by platform engineers for developer personas.
• Provide an empty state experience that is available by default, to enhance discoverability.

Out of Scope:

• Integration with the quick start experience
• Additional data sources beyond Jira and GitHub, although customers should be able to follow documentation and code examples to be able to utilize their own
• Customization, additional personas, and KPI aggregation

Considerations:

• Documentation: Comprehensive documentation is required, covering KPI configuration (YAML examples), developer access to KPIs and data sources, RBAC configurations, and architectural diagrams for platform engineers. The scorecard will likely be included in quick starts in future releases (1.9 or 1.10).

• Usability: Ensure the customization process for platform engineers is intuitive and well-documented.

• Scalability: Optimize data retrieval to minimize latency and ensure efficient updates.

• The scorecard will initially be released as a Red Hat specific plugin as a developer preview.

Who is your target persona?

<Role>

What stage of the user journey are you targeting?

<User journey>

Why is this content important?

<Justification>

What is the main user goal aka job to be done?

As a <role>, I want to <goal>

What high level steps does the user need to take to accomplish the goal?

1. <User steps to accomplish goal>
   

What pain points are the user likely to encounter when accomplishing this goal?

<Pain points>

Links to existing content

• <Add link to content>
  

People:

• SME: <SME>
  
• QE: <QE>
  

Release Note: Yes/No

Documentation Outline

• <Documentation outline>