From d7cf42c69ef18f1de85b179c3d6af1ae91b0c5ce Mon Sep 17 00:00:00 2001 From: Marek Libra Date: Thu, 25 Jan 2024 17:59:36 +0100 Subject: [PATCH] fix(notifications): improve README for adding users to Catalog (#1119) --- plugins/notifications-backend/README.md | 4 +- plugins/notifications-backend/package.json | 3 +- plugins/notifications-backend/users.yaml | 52 ---------------------- 3 files changed, 4 insertions(+), 55 deletions(-) diff --git a/plugins/notifications-backend/README.md b/plugins/notifications-backend/README.md index fe532ea2f0..7c9fd86d27 100644 --- a/plugins/notifications-backend/README.md +++ b/plugins/notifications-backend/README.md @@ -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 @@ -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 ``` diff --git a/plugins/notifications-backend/package.json b/plugins/notifications-backend/package.json index 2267f5d1ca..bf3a6d1755 100644 --- a/plugins/notifications-backend/package.json +++ b/plugins/notifications-backend/package.json @@ -65,6 +65,7 @@ "dist-dynamic/*.*", "dist-dynamic/dist/**", "dist-dynamic/alpha/*", - "config.d.ts" + "config.d.ts", + "users.yaml" ] } diff --git a/plugins/notifications-backend/users.yaml b/plugins/notifications-backend/users.yaml index 60fb810885..f5a8d85a8a 100644 --- a/plugins/notifications-backend/users.yaml +++ b/plugins/notifications-backend/users.yaml @@ -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: jenny-doe@example.com - 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: jenny-doe@example.com - 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: infrastructure@example.com - 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: infrastructure@example.com - picture: https://example.com/groups/bu-infrastructure.jpeg - parent: ops - children: [backstage, other] - members: [jdoe]