docs/{development, development-misc}: init, README: clean

README.md

@@ -1,40 +1,36 @@
-# PVV NixOS configs
+# PVV NixOS config
 
-## Hvordan endre på ting
+This repository contains the NixOS configurations for Programvareverkstedet's server closet.
+In addition to machine configurations, it also contains a bunch of shared modules, packages, and
+more.
 
-Før du endrer på ting husk å ikke putte ting som skal være hemmelig uten å først lese seksjonen for hemmeligheter!
+## Machines
 
-Etter å ha klonet prosjektet ned og gjort endringer kan du evaluere configene med:
+| Name                       | Type     | Description                                               |
+|----------------------------|----------|-----------------------------------------------------------|
+| [bekkalokk][bek]           | Physical | Our main web host, webmail, wiki, idp, minecraft map, ... |
+| [bicep][bic]               | Virtual  | Database host, matrix, git mirrors, ...                   |
+|  bikkje                    | Virtual  | Experimental login box                                    |
+| [brzeczyszczykiewicz][brz] | Physical | Shared music player                                       |
+| [georg][geo]               | Physical | Shared music player                                       |
+| [ildkule][ild]             | Virtual  | Logging and monitoring host, prometheus, grafana, ...     |
+| [kommode][kom]             | Virtual  | Gitea + Gitea pages                                       |
+| [lupine][lup]              | Physical | Gitea CI/CD runners                                       |
+|  shark                     | Virtual  | Test host for authentication, absolutely horrendous       |
+| [wenche][wen]              | Virtual  | Nix-builders, general purpose compute                     |
 
-`nix flake check --keep-going`
-
-før du bygger en maskin med:
-
-`nix build .#<maskinnavn>`
-
-hvis du vil være ekstra sikker på at alt bygger så kan du kjøre:
-
-`nix build .` for å bygge alle de viktige maskinene.
-
-NB: Dette kan ta opp til 30 minutter avhengig av hva som ligger i caches
-
-Husk å hvertfall stage nye filer om du har laget dem!
-
-Om alt bygger fint commit det og push til git repoet.
-Det er sikkert lurt å lage en PR først om du ikke er vandt til nix enda.
-
-Innen 24h skal alle systemene hente ned den nye konfigurasjonen og deploye den.
-
-Du kan tvinge en maskin til å oppdatere seg før dette ved å kjøre:
-`nixos-rebuild switch --update-input nixpkgs --update-input nixpkgs-unstable --no-write-lock-file --refresh --upgrade --flake git+https://git.pvv.ntnu.no/Drift/pvv-nixos-config.git`
-
-som root på maskinen.
-
-Hvis du ikke har lyst til å oppdatere alle pakkene (og kanskje måtte vente en stund!) kan du kjøre
-
-`nixos-rebuild switch --override-input nixpkgs nixpkgs --override-input nixpkgs-unstable nixpkgs-unstable --flake git+https://git.pvv.ntnu.no/Drift/pvv-nixos-config.git`
-
-## Annen dokumentasjon
+## Documentation
 
+- [Development - working on the PVV machines](./docs/development.md)
+- [Miscellaneous development notes](./docs/development-misc.md)
 - [User management](./docs/users.md)
 - [Secret management and `sops-nix`](./docs/secret-management.md)
+
+[bek]: https://wiki.pvv.ntnu.no/wiki/Maskiner/bekkalokk
+[bic]: https://wiki.pvv.ntnu.no/wiki/Maskiner/bicep
+[brz]: https://wiki.pvv.ntnu.no/wiki/Maskiner/brzęczyszczykiewicz
+[geo]: https://wiki.pvv.ntnu.no/wiki/Maskiner/georg
+[ild]: https://wiki.pvv.ntnu.no/wiki/Maskiner/ildkule
+[kom]: https://wiki.pvv.ntnu.no/wiki/Maskiner/kommode
+[lup]: https://wiki.pvv.ntnu.no/wiki/Maskiner/lupine
+[wen]: https://wiki.pvv.ntnu.no/wiki/Maskiner/wenche