From 7235b16054f1d786a75b09bd8259855156fe7952 Mon Sep 17 00:00:00 2001 From: Julio Zynger Date: Fri, 4 Mar 2022 09:51:29 +0100 Subject: [PATCH] Rename annotation Signed-off-by: Julio Zynger --- docs/features/software-catalog/well-known-annotations.md | 4 ++-- plugins/periskop/README.md | 2 +- plugins/periskop/api-report.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/features/software-catalog/well-known-annotations.md b/docs/features/software-catalog/well-known-annotations.md index 2f41377a36..4fa71329dd 100644 --- a/docs/features/software-catalog/well-known-annotations.md +++ b/docs/features/software-catalog/well-known-annotations.md @@ -222,13 +222,13 @@ definition. Specifying this annotation will enable GoCD related features in Backstage for that entity. -### periskop.io/name +### periskop.io/service-name ```yaml # Example: metadata: annotations: - periskop.io/name: pump-station + periskop.io/service-name: pump-station ``` The value of this annotation is the periskop project name for the given entity. diff --git a/plugins/periskop/README.md b/plugins/periskop/README.md index e475fd3477..35e86f083d 100644 --- a/plugins/periskop/README.md +++ b/plugins/periskop/README.md @@ -47,7 +47,7 @@ const componentPage = ( ```yaml annotations: - periskop.io/name: '' + periskop.io/service-name: '' ``` 6. Run app with `yarn start` and navigate to `/periskop` or a catalog entity 'Periskop' tab diff --git a/plugins/periskop/api-report.md b/plugins/periskop/api-report.md index 5412b70dfb..bd3e00d012 100644 --- a/plugins/periskop/api-report.md +++ b/plugins/periskop/api-report.md @@ -72,7 +72,7 @@ export interface NotFoundInInstance { } // @public -export const PERISKOP_NAME_ANNOTATION = 'periskop.io/name'; +export const PERISKOP_NAME_ANNOTATION = 'periskop.io/service-name'; // @public export class PeriskopApi {