{ "id": 3, "links": [ 1, 2 ], "status": "decided" }

3 — ADR Web Pages

Publish architectural decisions as ADR based web pages

Date: 2023-12-11 00:00:00 +0000 UTC

Status

Relates to:

/architecture/3-adr-web-pages

architecture

content kind: page

num pages 3

file range:

Make use of ADR /builds/rkottmann/semo-home-page/content/en/architecture/1-make-use-of-adr.md

test https://semo-xml.org/en/architecture/1-make-use-of-adr/

Context

Publish the architectural decisions made on SeMoX project on the homepage. In order:

  • Make ADR accessible for non technical experts
  • Integrate them with the whole web based documentation
  • Add and make accessible tags (a.k.a keywords) for each ADR

Decision

We will use extend Markdown based Architecture Decision Records with front matter in a way that they are publishable as web pages using Hugo SSG.

Consequences

The front matter and some rules need to be established in order to create and publish a consistent set of ADRs.

Last modified April 30, 2025: add architecture (3f367bf)

type architecture