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

Merge pull request #15477 from kuangp/docs/adrs

Browse Source 
docs(adrs): note default support for MADR 2.x
This commit is contained in:
Patrik Oldsberg
2023-01-04 11:27:30 +01:00
committed by GitHub
parent a747e003fa 21ffbdd5ee
commit dae9d7e34d
3 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/long-owls-raise.md
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-adr-backend': patch
'@backstage/plugin-adr': patch
---
Clarify that default ADR parsers support MADR specification v2.x
plugins/adr-backend/README.md
+1 -1
View File
@@ -37,7 +37,7 @@ indexBuilder.addCollator({
### Parsing custom ADR document formats
By default, the `DefaultAdrCollatorFactory` will parse and index documents that follow the [MADR](https://adr.github.io/madr/) standard file name and template format. If you use a different ADR format and file name convention, you can configure `DefaultAdrCollatorFactory` with custom `adrFilePathFilterFn` and `parser` options (see type definitions for details):
By default, the `DefaultAdrCollatorFactory` will parse and index documents that follow the [MADR v2.x standard file name and template format](https://github.com/adr/madr/tree/2.1.2). If you use a different ADR format and file name convention, you can configure `DefaultAdrCollatorFactory` with custom `adrFilePathFilterFn` and `parser` options (see type definitions for details):
```ts
DefaultAdrCollatorFactory.fromConfig({
plugins/adr/README.md
+1 -1
View File
@@ -81,7 +81,7 @@ case 'adr':
## 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:
By default, this plugin will parse ADRs according to the format specified by the [Markdown Architecture Decision Record (MADR) v2.x template](https://github.com/adr/madr/tree/2.1.2). If your ADRs are written using a different format, you can apply the following customizations to correctly identify and parse your documents:
### Custom Filename/Path Format