Rename annotation
Signed-off-by: Julio Zynger <julio.zynger@soundcloud.com>
This commit is contained in:
committed by
Fredrik Adelöw
parent
71ced2f7a5
commit
7235b16054
@@ -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.
|
||||
|
||||
@@ -47,7 +47,7 @@ const componentPage = (
|
||||
|
||||
```yaml
|
||||
annotations:
|
||||
periskop.io/name: '<THE NAME OF THE PERISKOP APP>'
|
||||
periskop.io/service-name: '<THE NAME OF THE PERISKOP APP>'
|
||||
```
|
||||
|
||||
6. Run app with `yarn start` and navigate to `/periskop` or a catalog entity 'Periskop' tab
|
||||
|
||||
@@ -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 {
|
||||
|
||||
Reference in New Issue
Block a user