Skip to content

Commit 9c15c94

Browse files
author
socadk
committed
Bug fixes and consistency edits in README and examples
1 parent b49cc8a commit 9c15c94

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This repository provides YAML ADR templates and examples.
88

99
* [YAML port of the Markdown Architectural Decisions (MADR) template](templates/yadr-template-full.yaml), as well as a [usage example](examples/yadr-template-full-example.yaml) for it.
1010
* [Bare version of the YADR template](templates/yadr-template-bare.yaml) and shortened [usage example](examples/yadr-template-bare-example.yaml).
11-
* [JSON conversions](examples-validation) of the YADR usage examples validate against the [JSON schema](schemas/yadr-schema.json) for the template. Note that the schema contains a placeholder ?`id-of-option-1` for the option name in its `pros-and-cons-of-the-options` object; this placeholder has to bne replaced by an existing option name if the validation is supposed to check this part. <!-- Note that this schema has been designed to validate all array elements, which requires the type definitions of the array elements to be scalar; see answer 1 to the question ["How do I make a jsonschema so that it validates all objects in array?"](https://stackoverflow.com/questions/49319692/how-do-i-make-a-jsonschema-so-that-it-validates-all-objects-in-array) on Stack Overflow for rationale -->
11+
* [JSON conversions](examples-validation) of the YADR usage examples validate against the [JSON schema](schemas/yadr-schema.json) for the template. Note that the schema contains a placeholder `id-of-option-1` for the option name in its `pros-and-cons-of-the-options` object; this placeholder has to bne replaced by an existing option name if the validation is supposed to check this part (in the examples, the option names are `yaml`, `madr` and `json)`. <!-- Note that this schema has been designed to validate all array elements, which requires the type definitions of the array elements to be scalar; see answer 1 to the question ["How do I make a jsonschema so that it validates all objects in array?"](https://stackoverflow.com/questions/49319692/how-do-i-make-a-jsonschema-so-that-it-validates-all-objects-in-array) on Stack Overflow for rationale -->
1212
* The folder [other YAML templates](templates/other-yaml-templates/) contains YAML ports of templates not originating from the MADR project, for instance, the [Y-Statement](https://medium.com/olzzio/y-statements-10eb07b5a177) template.
1313
* An [example](examples/other-yaml-templates/yaml-as-additional-y-statement-syntax.yaml) and two corresponding [JSON conversions](examples-validation/other-yaml-templates/) are available as well.
1414

examples-validation/use-yaml-as-adr-syntax.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
"Ability to write rich text with item lists, **bold** and *italic* settings, tables, hyperlinks"
1515
],
1616
"considered-options": [
17-
"Markdown with additional semantic anchors",
17+
"Markdown ADRs with additional semantic anchors",
1818
"JSON and JSON Schema",
1919
"[YAML](https://yaml.org/) with JSON Schema validation"
2020
],
2121
"pros-and-cons-of-the-options": {
22-
"madr": {
22+
"Markdown": {
2323
"pros": [
2424
"good for humans"
2525
],
@@ -31,15 +31,15 @@
3131
"open source tooling project stalled"
3232
]
3333
},
34-
"json": {
34+
"JSON": {
3535
"pros": [
3636
"good for machines"
3737
],
3838
"cons": [
3939
"readability for humans debatable"
4040
]
4141
},
42-
"yaml": {
42+
"YAML": {
4343
"pros": [
4444
"best of both worlds, many tools"
4545
],

0 commit comments

Comments
 (0)