nixos-config/modules/README.adoc

= Modules
:toc:

These are various modules ranging from link:https://nixos.org/manual/nixos/stable/index.html#sec-writing-modules[NixOS modules] and link:https://github.com/nix-community/home-manager[home-manager] modules.


[#design-constraints]
== Design constraints

While there are different environments we can make modules with, there are commonalities between these custom modules.
It's better that we lay this out with a list of guidelines.

* Absolutely no reliance on third-party modules.
This makes the custom modules easier to import whether it's used with flakes or not.
Instead I recommend to make full use of environment-specific module structuring (such as host-specific modules on NixOS, user-specific modules on home-manager) on their respective environment configurations.
As a bonus, this makes it easier to upstream them if we want to.

* That said, custom modules can rely on other custom modules.
Otherwise, we're just limiting ourselves by forcing the modules to be standalone.
Plus we could fix encountered issues with our own solution (and even upstream them if possible).

* Follow the upstream module design as much as possible.
This makes it easier to design custom module extensions around them.
(Also a bonus for easier time upstreaming the module if I want to.)
Update various configurations Flake outputs, hosts, users, and formatting of Nix files. et cetera, et cetera. 2021-12-11 05:37:27 +00:00			`= Modules`
			`:toc:`

Update miscellaneous modules and documentation 2021-12-19 09:37:47 +00:00			`These are various modules ranging from link:https://nixos.org/manual/nixos/stable/index.html#sec-writing-modules[NixOS modules] and link:https://github.com/nix-community/home-manager[home-manager] modules.`
Update various configurations Flake outputs, hosts, users, and formatting of Nix files. et cetera, et cetera. 2021-12-11 05:37:27 +00:00
Update miscellaneous modules and documentation 2021-12-19 09:37:47 +00:00


docs: update modules README with design guidelines 2024-01-18 09:00:31 +00:00			`[#design-constraints]`
			`== Design constraints`
Update miscellaneous modules and documentation 2021-12-19 09:37:47 +00:00
docs: update modules README with design guidelines 2024-01-18 09:00:31 +00:00			`While there are different environments we can make modules with, there are commonalities between these custom modules.`
			`It's better that we lay this out with a list of guidelines.`
Update miscellaneous modules and documentation 2021-12-19 09:37:47 +00:00
docs: update modules README with design guidelines 2024-01-18 09:00:31 +00:00			`* Absolutely no reliance on third-party modules.`
			`This makes the custom modules easier to import whether it's used with flakes or not.`
			`Instead I recommend to make full use of environment-specific module structuring (such as host-specific modules on NixOS, user-specific modules on home-manager) on their respective environment configurations.`
			`As a bonus, this makes it easier to upstream them if we want to.`

			`* That said, custom modules can rely on other custom modules.`
			`Otherwise, we're just limiting ourselves by forcing the modules to be standalone.`
			`Plus we could fix encountered issues with our own solution (and even upstream them if possible).`

			`* Follow the upstream module design as much as possible.`
			`This makes it easier to design custom module extensions around them.`
			`(Also a bonus for easier time upstreaming the module if I want to.)`