Skip to content

Commit

Permalink
fix(notifications): improve README for adding users to Catalog (#1119)
Browse files Browse the repository at this point in the history
  • Loading branch information
mareklibra authored Jan 25, 2024
1 parent bcca08a commit d7cf42c
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 55 deletions.
4 changes: 2 additions & 2 deletions plugins/notifications-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To install it as a dynamic plugin, please follow instructions here: https://gith

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

In any case, do not miss the info about configuration and especially about creating entities in Catalog as described below.
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).

## Getting started

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

Expand Down
3 changes: 2 additions & 1 deletion plugins/notifications-backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
"dist-dynamic/*.*",
"dist-dynamic/dist/**",
"dist-dynamic/alpha/*",
"config.d.ts"
"config.d.ts",
"users.yaml"
]
}
52 changes: 0 additions & 52 deletions plugins/notifications-backend/users.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,55 +6,3 @@ spec:
profile:
displayName: Guest User
memberOf: []
---
apiVersion: backstage.io/v1alpha1
kind: User
metadata:
name: jdoe
spec:
profile:
displayName: Jenny Doe
email: [email protected]
picture: https://example.com/staff/jenny-with-party-hat.jpeg
memberOf: [jdoe, jdoe-2]
---
apiVersion: backstage.io/v1alpha1
kind: User
metadata:
name: jdoe-2
spec:
profile:
displayName: Jenny Doe
email: [email protected]
picture: https://example.com/staff/jenny-with-party-hat.jpeg
memberOf: [jdoe]
---
apiVersion: backstage.io/v1alpha1
kind: Group
metadata:
name: jdoe
description: The infra business unit
spec:
type: business-unit
profile:
displayName: jdoe
email: [email protected]
picture: https://example.com/groups/bu-infrastructure.jpeg
parent: ops
children: [backstage, other]
members: [jdoe]
---
apiVersion: backstage.io/v1alpha1
kind: Group
metadata:
name: jdoe-2
description: The infra business unit
spec:
type: business-unit
profile:
displayName: jdoe
email: [email protected]
picture: https://example.com/groups/bu-infrastructure.jpeg
parent: ops
children: [backstage, other]
members: [jdoe]

0 comments on commit d7cf42c

Please sign in to comment.