Updated documentation

Added comments to exports. Updated READMEs for the adr-backend and adr plugins.

Signed-off-by: Robert Bunning <rbunning@webstaurantstore.com>
This commit is contained in:
Robert Bunning
2022-12-19 11:24:03 -05:00
parent fc1d240190
commit 99fea85ddf
5 changed files with 55 additions and 1 deletions
+2
View File
@@ -4,6 +4,8 @@ This ADR backend plugin is primarily responsible for the following:
- Provides a `DefaultAdrCollatorFactory`, which can be used in the search backend to index ADR documents associated with entities to your Backstage Search.
- Provides endpoints that use UrlReaders for getting a ADR documents (used in the [ADR frontend plugin](../adr/README.md)).
## 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).
@@ -18,6 +18,7 @@ import { UrlReader } from '@backstage/backend-common';
import express from 'express';
import Router from 'express-promise-router';
/** @public */
export async function createRouter(reader: UrlReader): Promise<express.Router> {
const router = Router();
router.use(express.json());