Skip to content

Commit bc88474

Browse files
author
socadk
committed
Moved comment and note to footnotes in README
1 parent 9c15c94 commit bc88474

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,14 @@ 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 (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 -->
11+
* [JSON conversions](examples-validation) of the YADR usage examples validate against the [JSON schema](schemas/yadr-schema.json)[^1] for the template.[^2]
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

15+
[^1]: 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.
16+
17+
[^2]: 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 be replaced by an existing option name if the validation is supposed to check this part. In the YADR examples, the option names are `YAML`, `Markdown` and `JSON`.
18+
1519
## Background information and tools
1620

1721
* Homepage of the [ADR organization on GitHub](https://adr.github.io/)

0 commit comments

Comments
 (0)