chore: fix some changeset

Signed-off-by: blam <ben@blam.sh>
2023-01-17 10:55:35 +01:00
parent b3fc621193
commit aa17643a06
5 changed files with 58 additions and 6 deletions
@@ -6,6 +6,59 @@ This ADR backend plugin is primarily responsible for the following:

 - Provides endpoints that use UrlReaders for getting ADR documents (used in the [ADR frontend plugin](../adr/README.md)).

+## Install
+
+## Setup your `integrations` config
+
+First off you'll need to setup your `integrations` config inside your `app-config.yaml`. You can skip this step if it's already setup previously, and if you need help configuring this you can read the [integrations documentation](https://backstage.io/docs/integrations/)
+
+### Up and Running
+
+Here's how to get the backend up and running:
+
+1. First we need to add the `@backstage/plugin-adr-backend` package to your backend:
+
+```sh
+# From the Backstage root directory
+cd packages/backend
+yarn add @backstage/plugin-adr-backend
+```
+
+2. Then we will create a new file named `packages/backend/src/plugins/adr.ts`, and add the
+   following to it:
+
+```ts
+import { createRouter } from '@backstage/plugin-adr-backend';
+import { Router } from 'express';
+import { PluginEnvironment } from '../types';
+
+export default async function createPlugin(
+  env: PluginEnvironment,
+): Promise<Router> {
+  return await createRouter({
+    reader: env.reader,
+    cacheClient: env.cache.getClient(),
+    logger: env.logger,
+  });
+}
+```
+
+3. Next we wire this into the overall backend router, edit `packages/backend/src/index.ts`:
+
+```ts
+import adr from './plugins/adr';
+// ...
+async function main() {
+  // ...
+  // Add this line under the other lines that follow the useHotMemoize pattern
+  const adrEnv = useHotMemoize(module, () => createEnv('adr'));
+  // ...
+  // Insert this line under the other lines that add their routers to apiRouter in the same way
+  apiRouter.use('/adr', await adr(adrEnv));
+```
+
+4. Now run `yarn start-backend` from the repo root
+
 ## Indexing ADR documents for search

 Before you are able to start indexing ADR documents to search, you need to go through the [search getting started guide](https://backstage.io/docs/features/search/getting-started).