os/doc
Benjamin Bädorf 6fca77a69f
Add basic ADR doc setup and first LVM ADR
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.
2022-10-29 22:07:49 +02:00
..
adr Add basic ADR doc setup and first LVM ADR 2022-10-29 22:07:49 +02:00
concepts tree: remove bud and all mentions of it 2022-08-14 17:16:54 +02:00
integrations Document using deploy-rs to deploy home-manager 2021-11-02 23:44:20 +02:00
outputs update pkgs documentation 2021-09-02 11:37:21 +02:00
start tree: remove bud and all mentions of it 2022-08-14 17:16:54 +02:00
theme doc: move all docs under doc 2021-04-18 20:42:49 -06:00
.gitignore doc: new mdbook documentation 2021-02-14 02:46:05 -07:00
api-reference-channels.md tree: remove bud and all mentions of it 2022-08-14 17:16:54 +02:00
api-reference-devshell.md tree: remove bud and all mentions of it 2022-08-14 17:16:54 +02:00
api-reference-home.md tree: remove bud and all mentions of it 2022-08-14 17:16:54 +02:00
api-reference-nixos.md tree: remove bud and all mentions of it 2022-08-14 17:16:54 +02:00
api-reference.md tree: remove bud and all mentions of it 2022-08-14 17:16:54 +02:00
book.toml Improve help and screen recording keybindings in sway 2022-08-14 18:03:32 +02:00
CONTRIBUTING.md tree: remove bud and all mentions of it 2022-08-14 17:16:54 +02:00
secrets.md Fix decryption location for agenix 2022-02-17 10:15:02 -06:00
SUMMARY.md tree: remove bud and all mentions of it 2022-08-14 17:16:54 +02:00
tests.md Update docs and scripts to use main branch. 2021-10-09 11:19:52 -05:00