paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 13 Packages Projects Releases Wiki Activity

Updated adr plugin's readme

Browse Source 
Signed-off-by: Robert Bunning <rbunning@webstaurantstore.com>
This commit is contained in:
Robert Bunning
2022-12-27 10:37:40 -05:00
parent 83dc6e4785
commit 015e76cbfd
1 changed files with 5 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/adr/README.md
+5 -26
View File
@@ -4,17 +4,19 @@ Welcome to the ADR plugin!
This plugin allows you to browse ADRs associated with your entities as well as a way to discover ADRs across others entities via Backstage Search. Use this to learn from the past experience of other projects to guide your own architecture decisions.
NOTE: By default, this plugin only supports entities/ADRs registered via GitHub integration. To get ADRs from other sites, see the [Using ADR plugin with sites other than GitHub](#using-adr-plugin-with-sites-other-than-github) section.
## Setup
Install this plugin:
1. Install this plugin:
```bash
# From your Backstage root directory
yarn --cwd packages/app add @backstage/plugin-adr
```
2. Make sure the [ADR backend plugin](../adr-backend/README.md) is installed.
3. [Configure integrations](https://backstage.io/docs/integrations/) for all sites you would like to pull ADRs from.
### Entity Pages
1. Add the plugin as a tab to your Entity pages:
@@ -77,29 +79,6 @@ case 'adr':
);
```
## Using ADR plugin with sites other than GitHub
By default, the ADR plugin will only be able to retrieve ADRs through GitHub. If you would like to use it with other sites (for instance, AzureDevops):
1. Make sure the [ADR backend plugin](../adr-backend/README.md) is installed.
2. [Configure an integration](https://backstage.io/docs/integrations/) for the site you would like to pull ADRs from.
3. Set the adrFileFetcher property on EntityAdrContent to urlReaderAdrFileFetcher:
```jsx
// In packages/app/src/components/catalog/EntityPage.tsx
import { EntityAdrContent, isAdrAvailable, urlReaderAdrFileFetcher } from '@backstage/plugin-adr';
...
const serviceEntityPage = (
<EntityLayout>
{/* other tabs... */}
<EntityLayout.Route if={isAdrAvailable} path="/adrs" title="ADRs">
<EntityAdrContent adrFileFetcher={urlReaderAdrFileFetcher} />
</EntityLayout.Route>
</EntityLayout>
```
## Custom ADR formats
By default, this plugin will parse ADRs according to the format specified by the [Markdown Architecture Decision Record (MADR)](https://adr.github.io/madr/) template. If your ADRs are written using a different format, you can apply the following customizations to correctly identify and parse your documents: