From d0c47ec505bbfa4e77ec546fffd4b201d0463cb3 Mon Sep 17 00:00:00 2001 From: Guilherme Oenning Date: Tue, 16 Nov 2021 11:34:52 +0000 Subject: [PATCH 1/4] fix incorrect class name on module-jsonfc Signed-off-by: goenning --- plugins/tech-insights-backend-module-jsonfc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/tech-insights-backend-module-jsonfc/README.md b/plugins/tech-insights-backend-module-jsonfc/README.md index 48c1e69919..7b5d48bf62 100644 --- a/plugins/tech-insights-backend-module-jsonfc/README.md +++ b/plugins/tech-insights-backend-module-jsonfc/README.md @@ -24,7 +24,7 @@ and modify the `techInsights.ts` file to contain a reference to the FactCheckers + logger, +}), - const builder = new DefaultTechInsightsBuilder({ + const builder = buildTechInsightsContext({ logger, config, database, From 2a0703d212d6a544d3a9ed894e94e029b18ef623 Mon Sep 17 00:00:00 2001 From: Guilherme Oenning Date: Tue, 16 Nov 2021 11:35:17 +0000 Subject: [PATCH 2/4] fix incorrect class name on backend Signed-off-by: goenning --- plugins/tech-insights-backend/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/tech-insights-backend/README.md b/plugins/tech-insights-backend/README.md index e2cc1c0252..764ad860b8 100644 --- a/plugins/tech-insights-backend/README.md +++ b/plugins/tech-insights-backend/README.md @@ -22,7 +22,7 @@ do this by creating a file called `packages/backend/src/plugins/techInsights.ts` ```ts import { createRouter, - DefaultTechInsightsBuilder, + buildTechInsightsContext, } from '@backstage/plugin-tech-insights-backend'; import { Router } from 'express'; import { PluginEnvironment } from '../types'; @@ -33,7 +33,7 @@ export default async function createPlugin({ discovery, database, }: PluginEnvironment): Promise { - const builder = new DefaultTechInsightsBuilder({ + const builder = buildTechInsightsContext({ logger, config, database, From 2dc6eb8fdd671b68298279672dc260bdb2177442 Mon Sep 17 00:00:00 2001 From: goenning Date: Wed, 17 Nov 2021 18:52:57 +0000 Subject: [PATCH 3/4] factRefs to factIds Signed-off-by: goenning --- plugins/tech-insights-backend-module-jsonfc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/tech-insights-backend-module-jsonfc/README.md b/plugins/tech-insights-backend-module-jsonfc/README.md index 7b5d48bf62..c0f992ffc7 100644 --- a/plugins/tech-insights-backend-module-jsonfc/README.md +++ b/plugins/tech-insights-backend-module-jsonfc/README.md @@ -59,7 +59,7 @@ export const exampleCheck: TechInsightJsonRuleCheck = { name: 'demodatacheck', // A human readable name of this check to be displayed in the UI type: JSON_RULE_ENGINE_CHECK_TYPE, // Type identifier of the check. Used to run logic against, determine persistence option to use and render correct components on the UI description: 'A fact check for demoing purposes', // A description to be displayed in the UI - factRefs: ['demo-poc.factretriever'], // References to fact containers that this check uses. See documentation on FactRetrievers for more information on these + factIds: ['documentation-number-factretriever'], // References to fact ids that this check uses. See documentation on FactRetrievers for more information on these rule: { // The actual rule conditions: { From 2017de90da1d5bf37d8834d93ee1d479ab9e85d0 Mon Sep 17 00:00:00 2001 From: goenning Date: Thu, 18 Nov 2021 15:53:50 +0000 Subject: [PATCH 4/4] add changeset Signed-off-by: goenning --- .changeset/curly-points-hide.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/curly-points-hide.md diff --git a/.changeset/curly-points-hide.md b/.changeset/curly-points-hide.md new file mode 100644 index 0000000000..ba513e5915 --- /dev/null +++ b/.changeset/curly-points-hide.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-tech-insights-backend': patch +'@backstage/plugin-tech-insights-backend-module-jsonfc': patch +--- + +Update README docs to use correct function/parameter names