Commit graph

73 commits

Author SHA1 Message Date
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
Benjamin Bädorf 043178172b
Improve help and screen recording keybindings in sway
This commit shuffles around some sway keybindings and improves the
screen recording experience by adding a small wrapper around `slurp` and
`wf-recorder` conveniently called `record-screen`.

* `$mod+F5` now reload the sway configuration,
* `$mod+Ctrl+r` starts a screen recording (to stop it, go to workspace 7
  and kill the process),
* `record-screen` and the firefox sharing indicator are both on
  workspace 7 now, making it the "trash" workspace,
* `$mod+F1` and `$mod+Shift+h` now open Firefox with the docs of our
repository availabe under `help.local`.
* To not infuriate `qMasterPassword` users, that is now available under
`$mod+Shift+m` instead of `$mod+F1`.
2022-08-14 18:03:32 +02:00
teutat3s 1c015508e1
tree: remove bud and all mentions of it
Include upstream update doc updates
2022-08-14 17:16:54 +02:00
Brendan Tobolaski d6b84ca240
Fix decryption location for agenix 2022-02-17 10:15:02 -06:00
Ben Merritt fbfb84b96c Fix outdated option name 2022-01-10 23:21:52 -08:00
Ben Merritt a7fae1dbcc Update secrets path
See e538664435
2022-01-09 00:14:24 -08:00
Michael Reddick 70545abd1b docs: fix typo in start/bootstrapping 2021-11-20 15:58:37 -06:00
Timothy DeHerrera fca9289eec
Merge pull request #395 from pub-solar/refactor/remove-git-crypt
Remove git crypt, update docs
2021-11-13 14:09:09 -07:00
Karolis Labrencis 89b3cf78fd Document using deploy-rs to deploy home-manager 2021-11-02 23:44:20 +02:00
Benjamin Bädorf 243116e228
Remove git crypt, update docs 2021-10-24 19:36:56 +02:00
Karolis Labrencis 65db5d30ae docs: remove outdated nix-rebuild notes 2021-10-23 17:50:49 -05:00
Trevor Riles 804e972c57 Update docs and scripts to use main branch.
When following the getting started guide commands were failing due to
the mater branch not existing. I went through and updated all
references in the docs and other scripts from master to main.
2021-10-09 11:19:52 -05:00
Joel 8684105d21
docs: fix typos in concepts/suites 2021-10-07 19:11:21 +10:00
Chris Montgomery 95f89c0b44 docs: use single quotes in example to avoid shell expansion 2021-09-20 08:10:31 -05:00
Chris Montgomery ccf160dd21 docs: deploy command example is run from repo root 2021-09-20 08:10:31 -05:00
Chris Montgomery 0770c7f900 docs: bud get creates a directory named devos by default
As mentioned in #370 it would not result in a directory called `bud`, as
can be seen in the custom `get.bash` command where the directory name
defaults to `devos`.
2021-09-20 08:10:31 -05:00
Chris Montgomery 57a14bb411 docs: update links to point to master instead of core 2021-09-20 08:10:31 -05:00
Chris Montgomery 955b9ce1c1 docs(bud): replace references to flk 2021-09-20 08:10:31 -05:00
Chris Montgomery c3461cd2c3 docs: master is the current target branch for pull requests 2021-09-19 07:32:52 -05:00
Anton a3b2bcf3d5 fix typo in CONTRIBUTING.md 2021-09-18 09:20:09 -05:00
benneti 0536d0de90
update pkgs documentation 2021-09-02 11:37:21 +02:00
David Arnold 079adc4474
fix: more docs w.r.t. bootstrap iso 2021-08-12 20:57:22 -05:00
David Arnold c46d923876
fix: iso docs w.r.t. bud burn and bootstrap.nix 2021-08-12 20:51:18 -05:00
David Arnold 32bddf6403
fix: docs bootsrtap - swap disk by label (easied copy/paste) 2021-08-12 20:48:30 -05:00
David Arnold c30870f266
imp: bootstrap docs 2021-08-12 20:46:03 -05:00
David Arnold 2fcb3605ee
docs: soft update (fix the most obvious drift) 2021-08-01 16:38:52 -05:00
David Arnold b95189d754
rm: community
the commmunity branch was fallen too far behind and there where no
contributions to it, anyways. We will start linking usage examples
out in the wild, instead.
2021-07-16 12:50:18 -05:00
David Arnold b927d97ce2
doc: nvfetcher 2021-06-24 21:37:51 -05:00
Pacman99 a7c20465ec doc/suites: updating explanation of suites 2021-06-08 18:27:54 -07:00
Pacman99 9dcc4adeef
Merge pull request #311 from almostnobody/patch-1
override module doc: fix #310
2021-06-08 14:07:19 -07:00
almostnobody d852305c4c
Update doc/concepts/overrides.md
Co-authored-by: Pacman99 <pachum99@myrdd.info>
2021-06-08 22:24:24 +03:00
almostnobody c30e8c5ca2
override module doc: fix #310 2021-06-08 22:10:17 +03:00
Pacman99 fe3a624930 docs: general updates 2021-06-05 10:10:05 -07:00
Jarosław Wygoda 454b27937f customBuilds: add digitalOcean 2021-06-03 08:48:25 +02:00
Pacman99 768e3e7541 Merge branch 'core' into develop 2021-05-27 11:02:41 -07:00
Narice 20649fb3a9 Added note about cache in the start index
This resolves #292.
2021-05-24 10:42:57 +02:00
Pacman99 adaf76e1fb doc/hosts: update to new auto-import style 2021-05-18 10:23:43 -07:00
Yannick Markus 629a50975f
hosts doc: fix hardware module in example 2021-05-18 18:11:29 +02:00
Narice cf47170d6f Modified wording of iso documentation 2021-05-17 09:15:08 -04:00
Pacman99 c57925d35a document agenix integration
Co-authored-by: David Arnold <dar@xoe.solutions>
2021-05-14 18:38:55 -07:00
Pacman99 0d7eb1c488 doc/lib: explain ourlib usage 2021-05-11 11:44:05 -07:00
Pacman99 725e459655
doc/start: fix grammar
Co-authored-by: David Arnold <dar@xoe.solutions>
2021-05-10 12:22:16 -07:00
Pacman99 8f20bb069a
doc/extern: elaborate external modules filtering
Co-authored-by: David Arnold <dar@xoe.solutions>
2021-05-10 12:19:31 -07:00
Pacman99 6e906e87bc
doc/extern: improve overlay filtering explanation
Co-authored-by: David Arnold <dar@xoe.solutions>
2021-05-10 12:17:41 -07:00
Pacman99 4b4f9dc45c Merge branch 'core' into develop 2021-05-06 13:55:02 -07:00
Pacman99 23ee58d2d0 use __dontExport property for lib and overrides 2021-04-29 11:55:42 -07:00
Pacman99 bb9bc02478 fix channels.*.input defaultText formatting 2021-04-27 12:52:16 -07:00
Pacman99 aa825b87a6 auto import hosts in flake.nix
this allows host-specific settings to be overriden with mkMerge
2021-04-27 10:26:45 -07:00
Pacman99 df39cb692e rebuild and update mkFlakeOptions.md 2021-04-27 09:52:56 -07:00
Pacman99 d5276195f7 move overrides.nix to overlays
also update overrides docs
it is a pure devos overlay now, it makes sense to go in overlays
2021-04-27 09:47:04 -07:00