Skip to content

tech-insights: update correct param name in README #8378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kurtaking merged 1 commit into from
Mar 31, 2026
+8 −3
Merged

tech-insights: update correct param name in README #8378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions workspaces/tech-insights/.changeset/bright-lies-pump.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@backstage-community/plugin-tech-insights': patch
---

Update correct param name in README.
6 changes: 3 additions & 3 deletions workspaces/tech-insights/plugins/tech-insights/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If you are using Backstage's [new frontend system](https://backstage.io/docs/fro

#### Creating custom scorecards with TechInsightsScorecardBlueprint

The `TechInsightsScorecardBlueprint` allows you to create custom scorecard content that can be filtered to specific entities. This is useful when you want different scorecards to appear for different entity types or based on entity metadata. The `filter` parameter uses the same entity predicate format as other Backstage entity filters, allowing you to match on `kind`, `metadata`, `spec` fields, and more.
The `TechInsightsScorecardBlueprint` allows you to create custom scorecard content that can be filtered to specific entities. This is useful when you want different scorecards to appear for different entity types or based on entity metadata. The `entityFilter` parameter uses the same entity predicate format as other Backstage entity filters, allowing you to match on `kind`, `metadata`, `spec` fields, and more.

```ts
import { createFrontendModule } from '@backstage/frontend-plugin-api';
Expand All @@ -40,7 +40,7 @@ const techInsightsModule = createFrontendModule({
TechInsightsScorecardBlueprint.make({
name: 'apis',
params: {
filter: { kind: 'api' },
entityFilter: { kind: 'api' },
title: 'API Scorecard',
description: 'Checks specific to API entities',
checkIds: ['apiDefinitionCheck'],
Expand All @@ -49,7 +49,7 @@ const techInsightsModule = createFrontendModule({
TechInsightsScorecardBlueprint.make({
name: 'production-apis',
params: {
filter: { kind: 'api', 'spec.lifecycle': 'production' },
entityFilter: { kind: 'api', 'spec.lifecycle': 'production' },
title: 'Production API Scorecard',
checkIds: ['groupOwnerCheck', 'productionReadinessCheck'],
},
Expand Down
Loading