Add basic ADR doc setup and first LVM ADR #149

Closed

b12f wants to merge 1 commit from adr/01-lvm-on-luks into main

b12f commented

2022-10-29 20:34:22 +00:00

(Migrated from git.b12f.io)

This commit introduces Architectural Decision Records. To quote:

Architectural Decision Records (ADRs)

An Architectural Decision (AD) is a software design choice that
addresses a functional or non-functional requirement that is
architecturally significant. An Architecturally Significant
Requirement (ASR) is a requirement that has a measurable effect on a
software system’s architecture and quality. An Architectural Decision
Record (ADR) captures a single AD, such as often done when writing
personal notes or meeting minutes; the collection of ADRs created
and maintained in a project constitute its decision log. All these
are within the topic of Architectural Knowledge Management (AKM), but
ADR usage can be extended to design and other decisions (“any
decision record”).

Taken from https://adr.github.io/

This commit also adds the first ADR; both as an example as well as a
serious proposal. This ADR is a product of discussions around
encrypted swap, hibernation, onboarding of new devices, and fragmentation.

This commit introduces Architectural Decision Records. To quote: > Architectural Decision Records (ADRs) > > An Architectural Decision (AD) is a software design choice that > addresses a functional or non-functional requirement that is > architecturally significant. An Architecturally Significant > Requirement (ASR) is a requirement that has a measurable effect on a > software system’s architecture and quality. An Architectural Decision > Record (ADR) captures a single AD, such as often done when writing > personal notes or meeting minutes; the collection of ADRs created > and maintained in a project constitute its decision log. All these > are within the topic of Architectural Knowledge Management (AKM), but > ADR usage can be extended to design and other decisions (“any > decision record”). Taken from https://adr.github.io/ This commit also adds the first ADR; both as an example as well as a serious proposal. This ADR is a product of discussions around encrypted swap, hibernation, onboarding of new devices, and fragmentation.

hensoko (Migrated from git.b12f.io) reviewed 2022-10-30 20:29:43 +00:00

hensoko (Migrated from git.b12f.io) approved these changes 2022-10-30 20:30:03 +00:00