Skip to content

🚀 tech-insights-maturity: Allow EntityMaturity summary, score cards to work with other entity kinds #7500

@gmartin-cloudflare

Description

@gmartin-cloudflare

Workspace

tech-insights

🔖 Feature description

According to the documentation of the tech-insights-maturity plugin and my own testing, the EntityMaturityScorecard and EntityMaturitySummaryCard only work on the Component entity kind. We would like to additionally show the check results and ranking for:

  • System
  • Group
  • Domain
  • API
  • Resource

🎤 Context

Example use case: We'd like to encourage that all System entities have a filled-out Description field and some certain annotations. These checks are separate from the components that belong to the System. We can currently add checks for these in tech-insights, but cannot show their rank in a Maturity context.

Similar examples exist for the other entity kinds I mentioned.

✌️ Possible Implementation

The main issue is preserving the EntityMaturitySummaryContent element, while also showing the EntityMaturityScoreCard for the System, Domain, and Group types. The easiest solution is probably to allow two separate paths linked on the Entity page (Maturity and Maturity Summary or similar). Alternately, embedding the scorecard in the summary content element but making it clear it's scoped to the entity somehow would work.

I am willing to submit a PR, but my comfort level with Backstage plugins and React development is rather low; it would likely be faster and higher quality for a formal author of the plugin to make these changes.

👀 Have you spent some time to check if this feature request has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

Yes I am willing to submit a PR!

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestworkspace/tech-insightsUsed to tag tech-insights workspace issues and pull requests

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions