foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-31 04:58:01 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs/site: add design guidelines for workflow modules

Browse Source
This commit is contained in:
Gabriel Arazas 2024-01-01 13:58:16 +08:00
parent 9bb03e86b8
commit eaf95b5686
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/content/en-US/04-nixos-modules/02-workflows/index.adoc
View File

@ -56,3 +56,15 @@ Whether those rices are worth posting to Unix ricing communities is up to you th
====
Whippersnappers with your "riced"-up systems...
====
There are a few guidelines to designing a workflow module which is already laid out in its respective README but as a reminder, let's list it here.
* All workflow modules should be under `workflows.workflows.<name>` namespace with an `enable` option.
* No usage of the private modules.
It is a public module, after all so it'll make things messier.
While we can conditionally set the configuration, it is pretty useless since we have the host-specific module structure.
* No locale-related settings.
Each user may have its own set of preferred locales and their setup so it is pretty much prohibited from setting any.
The only related parts a workflow module can set is their preferred input method engine (IME) of choice.