From eaf95b5686748abf2d759a8fbdeb53fecf5191a9 Mon Sep 17 00:00:00 2001 From: Gabriel Arazas Date: Mon, 1 Jan 2024 13:58:16 +0800 Subject: [PATCH] docs/site: add design guidelines for workflow modules --- .../en-US/04-nixos-modules/02-workflows/index.adoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/content/en-US/04-nixos-modules/02-workflows/index.adoc b/docs/content/en-US/04-nixos-modules/02-workflows/index.adoc index a94a244e..e605cce3 100644 --- a/docs/content/en-US/04-nixos-modules/02-workflows/index.adoc +++ b/docs/content/en-US/04-nixos-modules/02-workflows/index.adoc @@ -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.` 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.