From 3df39d8ed3710bc4212d7e1f3ea1e83fa4202206 Mon Sep 17 00:00:00 2001 From: Nigel Wright Date: Tue, 28 Dec 2021 13:25:05 +1300 Subject: [PATCH 1/3] added additional information for s3 discovery usage Signed-off-by: Nigel Wright --- docs/integrations/aws-s3/discovery.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/integrations/aws-s3/discovery.md b/docs/integrations/aws-s3/discovery.md index d50aceacb8..656cb9f7b3 100644 --- a/docs/integrations/aws-s3/discovery.md +++ b/docs/integrations/aws-s3/discovery.md @@ -26,3 +26,16 @@ catalog: ``` Note the `s3-discovery` type, as this is not a regular `url` processor. + +As this processor is not one of the default providers, you will also need to add the below: + +```javascript +/* packages/backend/src/plugins/catalog.ts */ + +import { AwsS3DiscoveryProcessor} from '@backstage/plugin-catalog-backend'; + + +const builder = await CatalogBuilder.create(env); +/** ... other processors ... */ +builder.addProcessor(new AwsS3DiscoveryProcessor(env.reader)) +``` From fb33739fbe3984f0cc00f2c90528dc28649f9d33 Mon Sep 17 00:00:00 2001 From: Nigel Wright Date: Mon, 10 Jan 2022 08:16:21 +1300 Subject: [PATCH 2/3] updated integration instructions Signed-off-by: Nigel Wright --- docs/integrations/aws-s3/discovery.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/aws-s3/discovery.md b/docs/integrations/aws-s3/discovery.md index 656cb9f7b3..5895ab453e 100644 --- a/docs/integrations/aws-s3/discovery.md +++ b/docs/integrations/aws-s3/discovery.md @@ -27,9 +27,9 @@ catalog: Note the `s3-discovery` type, as this is not a regular `url` processor. -As this processor is not one of the default providers, you will also need to add the below: +As this processor is not one of the default providers, you will also need to add the below to `packages/backend/src/plugins/catalog.ts`: -```javascript +```ts /* packages/backend/src/plugins/catalog.ts */ import { AwsS3DiscoveryProcessor} from '@backstage/plugin-catalog-backend'; From 5de4482b44dc22b70b647694a44dfe63d37014e7 Mon Sep 17 00:00:00 2001 From: Nigel Wright Date: Tue, 11 Jan 2022 09:16:25 +1300 Subject: [PATCH 3/3] chore: cleaned up markdown with prettier Signed-off-by: Nigel Wright --- docs/integrations/aws-s3/discovery.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/integrations/aws-s3/discovery.md b/docs/integrations/aws-s3/discovery.md index 5895ab453e..545a578e63 100644 --- a/docs/integrations/aws-s3/discovery.md +++ b/docs/integrations/aws-s3/discovery.md @@ -27,15 +27,15 @@ catalog: Note the `s3-discovery` type, as this is not a regular `url` processor. -As this processor is not one of the default providers, you will also need to add the below to `packages/backend/src/plugins/catalog.ts`: +As this processor is not one of the default providers, you will also need to add +the below to `packages/backend/src/plugins/catalog.ts`: ```ts /* packages/backend/src/plugins/catalog.ts */ - -import { AwsS3DiscoveryProcessor} from '@backstage/plugin-catalog-backend'; +import { AwsS3DiscoveryProcessor } from '@backstage/plugin-catalog-backend'; const builder = await CatalogBuilder.create(env); /** ... other processors ... */ -builder.addProcessor(new AwsS3DiscoveryProcessor(env.reader)) +builder.addProcessor(new AwsS3DiscoveryProcessor(env.reader)); ```