diff --git a/docs/features/software-catalog/external-integrations.md b/docs/features/software-catalog/external-integrations.md index 9f592e7cca..a344f478d7 100644 --- a/docs/features/software-catalog/external-integrations.md +++ b/docs/features/software-catalog/external-integrations.md @@ -368,7 +368,7 @@ The class will have this basic structure: ```ts import { UrlReader } from '@backstage/backend-common'; import { - results, + processingResult, CatalogProcessor, CatalogProcessorEmit, LocationSpec, @@ -396,10 +396,10 @@ export class SystemXReaderProcessor implements CatalogProcessor { // your choosing. const data = await this.reader.read(location.target); const json = JSON.parse(data.toString()); - // Repeatedly call emit(results.entity(location, )) + // Repeatedly call emit(processingResult.entity(location, )) } catch (error) { const message = `Unable to read ${location.type}, ${error}`; - emit(results.generalError(location, message)); + emit(processingResult.generalError(location, message)); } return true; @@ -450,7 +450,7 @@ behavior for `system-x` that we implemented earlier. import { UrlReader } from '@backstage/backend-common'; import { Entity } from '@backstage/catalog-model'; import { - results, + processingResult, CatalogProcessor, CatalogProcessorEmit, CatalogProcessorCache, @@ -515,7 +515,7 @@ export class SystemXReaderProcessor implements CatalogProcessor { // For this example the JSON payload is a single entity. const entity: Entity = JSON.parse(response.buffer.toString()); - emit(results.entity(location, entity)); + emit(processingResult.entity(location, entity)); // Update the cache with the new ETag and entity used for the next run. await cache.set(CACHE_KEY, { @@ -525,10 +525,10 @@ export class SystemXReaderProcessor implements CatalogProcessor { } catch (error) { if (error.name === 'NotModifiedError' && cacheItem) { // The ETag matches and we have a cached value from the previous run. - emit(results.entity(location, cacheItem.entity)); + emit(processingResult.entity(location, cacheItem.entity)); } const message = `Unable to read ${location.type}, ${error}`; - emit(results.generalError(location, message)); + emit(processingResult.generalError(location, message)); } return true; diff --git a/docs/tutorials/package-role-migration.md b/docs/tutorials/package-role-migration.md index 10d6eca586..0af5fdb615 100644 --- a/docs/tutorials/package-role-migration.md +++ b/docs/tutorials/package-role-migration.md @@ -33,7 +33,7 @@ the `@backstage/cli`. ### TL;DR, Step 1-4: -This is a sorter version of all of the steps below, in case you're in a hurry. +This is a shorter version of all of the steps below, in case you're in a hurry. Run the following commands: