Skip to content

Commit d7cf42c

Browse files
authored
fix(notifications): improve README for adding users to Catalog (#1119)
1 parent bcca08a commit d7cf42c

File tree

3 files changed

+4
-55
lines changed

3 files changed

+4
-55
lines changed

plugins/notifications-backend/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To install it as a dynamic plugin, please follow instructions here: https://gith
1212

1313
To install it as a static plugin, several steps are required as described below.
1414

15-
In any case, do not miss the info about configuration and especially about creating entities in Catalog as described below.
15+
In any case, do not miss the info about configuration and especially about creating entities [in Catalog as described below](#important-user-entities-in-catalog).
1616

1717
## Getting started
1818

@@ -192,7 +192,7 @@ catalog:
192192
locations:
193193
# Local example data, file locations are relative to the backend process, typically `packages/backend`
194194
- type: file
195-
# *** Here is a new change, referes to a file stored in the root of the Backstage:
195+
# *** Here is a new change, refers to a file stored in the root of the Backstage:
196196
target: ../../users.yaml
197197
```
198198

plugins/notifications-backend/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@
6565
"dist-dynamic/*.*",
6666
"dist-dynamic/dist/**",
6767
"dist-dynamic/alpha/*",
68-
"config.d.ts"
68+
"config.d.ts",
69+
"users.yaml"
6970
]
7071
}

plugins/notifications-backend/users.yaml

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -6,55 +6,3 @@ spec:
66
profile:
77
displayName: Guest User
88
memberOf: []
9-
---
10-
apiVersion: backstage.io/v1alpha1
11-
kind: User
12-
metadata:
13-
name: jdoe
14-
spec:
15-
profile:
16-
displayName: Jenny Doe
17-
18-
picture: https://example.com/staff/jenny-with-party-hat.jpeg
19-
memberOf: [jdoe, jdoe-2]
20-
---
21-
apiVersion: backstage.io/v1alpha1
22-
kind: User
23-
metadata:
24-
name: jdoe-2
25-
spec:
26-
profile:
27-
displayName: Jenny Doe
28-
29-
picture: https://example.com/staff/jenny-with-party-hat.jpeg
30-
memberOf: [jdoe]
31-
---
32-
apiVersion: backstage.io/v1alpha1
33-
kind: Group
34-
metadata:
35-
name: jdoe
36-
description: The infra business unit
37-
spec:
38-
type: business-unit
39-
profile:
40-
displayName: jdoe
41-
42-
picture: https://example.com/groups/bu-infrastructure.jpeg
43-
parent: ops
44-
children: [backstage, other]
45-
members: [jdoe]
46-
---
47-
apiVersion: backstage.io/v1alpha1
48-
kind: Group
49-
metadata:
50-
name: jdoe-2
51-
description: The infra business unit
52-
spec:
53-
type: business-unit
54-
profile:
55-
displayName: jdoe
56-
57-
picture: https://example.com/groups/bu-infrastructure.jpeg
58-
parent: ops
59-
children: [backstage, other]
60-
members: [jdoe]

0 commit comments

Comments
 (0)