From d5ddc4e4672921b41b0cd8935a7d833fa84d7819 Mon Sep 17 00:00:00 2001
From: Patrick Jungermann <Patrick.Jungermann@gmail.com>
Date: Tue, 9 Jan 2024 01:28:55 +0100
Subject: [PATCH] docs(events): add docs for new backend system

Add documentation on how to install the plugins
with the new backend system.

Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>
---
 .changeset/stale-cars-attack.md               |  6 +++++
 .../events-backend-module-aws-sqs/README.md   |  4 ++++
 plugins/events-backend/README.md              | 24 ++++++++++++-------
 3 files changed, 26 insertions(+), 8 deletions(-)
 create mode 100644 .changeset/stale-cars-attack.md

diff --git a/.changeset/stale-cars-attack.md b/.changeset/stale-cars-attack.md
new file mode 100644
index 0000000000..431cc9232c
--- /dev/null
+++ b/.changeset/stale-cars-attack.md
@@ -0,0 +1,6 @@
+---
+'@backstage/plugin-events-backend-module-aws-sqs': patch
+'@backstage/plugin-events-backend': patch
+---
+
+Add documentation on how to install the plugins with the new backend system.
diff --git a/plugins/events-backend-module-aws-sqs/README.md b/plugins/events-backend-module-aws-sqs/README.md
index cb3a5045c0..397de35c10 100644
--- a/plugins/events-backend-module-aws-sqs/README.md
+++ b/plugins/events-backend-module-aws-sqs/README.md
@@ -40,3 +40,7 @@ events:
 # From your Backstage root directory
 yarn add --cwd packages/backend @backstage/plugin-events-backend-module-aws-sqs
 ```
+
+```ts title="packages/backend/src/index.ts"
+backend.add(import('@backstage/plugin-events-backend-module-aws-sqs/alpha'));
+```
diff --git a/plugins/events-backend/README.md b/plugins/events-backend/README.md
index 29c420cef2..6fa02a7e6a 100644
--- a/plugins/events-backend/README.md
+++ b/plugins/events-backend/README.md
@@ -24,7 +24,15 @@ to the used event broker.
 yarn add --cwd packages/backend @backstage/plugin-events-backend @backstage/plugin-events-node
 ```
 
-### Event Broker
+### Add to backend
+
+```ts title="packages/backend/src/index.ts"
+backend.add(import('@backstage/plugin-events-backend/alpha'));
+```
+
+### Add to backend (old)
+
+#### Event Broker
 
 First you will need to add and implementation of the `EventBroker` interface to the backend plugin environment.
 This will allow event broker instance any backend plugins to publish and subscribe to events in order to communicate
@@ -44,7 +52,7 @@ Then update plugin environment to include the event broker.
 +  eventBroker: EventBroker;
 ```
 
-### Publishing and Subscribing to events with the broker
+#### Publishing and Subscribing to events with the broker
 
 Backend plugins are passed the event broker in the plugin environment at startup of the application. The plugin can
 make use of this to communicate between parts of the application.
@@ -80,27 +88,27 @@ export default async function createPlugin(
 }
 ```
 
-### Implementing an `EventSubscriber` class
+#### Implementing an `EventSubscriber` class
 
 More complex solutions might need the creation of a class that implements the `EventSubscriber` interface. e.g.
 
 ```typescript jsx
-import { EventSubscriber } from "./EventSubscriber";
+import { EventSubscriber } from './EventSubscriber';
 
 class ExampleSubscriber implements EventSubscriber {
-  ...
+  // ...
 
   supportsEventTopics() {
-      return ['publish.example']
+    return ['publish.example'];
   }
 
   async onEvent(params: EventParams) {
-    env.logger.info(`receieved ${params.topic} event`)
+    env.logger.info(`receieved ${params.topic} event`);
   }
 }
 ```
 
-### Events Backend
+#### Events Backend
 
 The events backend plugin provides a router to handler http events and publish the http requests onto the event
 broker.