diff --git a/docs/config/_default/config.toml b/docs/config/_default/config.toml index fe47a94c..1ba298a6 100644 --- a/docs/config/_default/config.toml +++ b/docs/config/_default/config.toml @@ -1,5 +1,5 @@ baseURL = 'https://foo-dogsquared.github.io/nixos-config' -defaultContentLanguage = 'en-US' +defaultContentLanguage = 'en' title = "foodogsquared's NixOS config" timeZone = "UTC" diff --git a/docs/content/en-US/04-nixos-modules/01-workflows/index.adoc b/docs/content/en-US/04-nixos-modules/01-workflows/index.adoc deleted file mode 100644 index 500aba2e..00000000 --- a/docs/content/en-US/04-nixos-modules/01-workflows/index.adoc +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Workflows ---- -= Workflows - -Workflows are all-encompassing NixOS modules for dictating how you interact with your computer/device/whatever. -Basically, this is where certain things are set such as your GNOME desktop environment settings, your dolled up standalone window manager setup, or an oddball audio-only desktop interface. -They are located in `./nixos/modules/workflows` at the project root. - -Workflows are defined under the namespace `workflows` where each workflow module is set to be declared and to be enabled at `workflows.workflows..enable`. -For example, here's how I would enable my imaginary GNOME desktop workflow. - -[source, nix] ----- -{ config, lib, pkgs, ... }: - -{ - workflows.workflows.a-happy-gnome.enable = true; -} ----- - -Take note you cannot enable more than two workflows at any given time. - -[source, nix] ----- -{ config, lib, pkgs, ... }: - -{ - # This would cause an assertion error. - workflows.workflows = { - a-happy-gnome.enable = true; - knome.enable = true; - }; -} ----- - -You can get around this by setting `workflows.disableLimit` to `true`. -However, this shouldn't be taken lightly as workflow modules are very vast in scope and are expected to set system settings that can affect your hardware including... - -* Enabling (and/or disabling) system services such as the preferred network manager. -* Modifying the list of installed applications. -* Setting up programs with custom configurations which could cause conflicts with the defaults (upstream or from nixpkgs) or with another workflow module. - -[chat, foodogsquared] -==== -By organizing the workflow modules this way, you can easily create your desktop rices without overlapping system settings. -Bless the Nix module system! -==== - -[chat, foodogsquared, state=cheeky] -==== -Whether those rices are worth posting to Unix ricing communities is up to you though. -==== - -[chat, Ezran, state=disappointed, role=reversed] -==== -Whippersnappers with your "riced"-up systems... -==== - - - - -== Designing a workflow module - -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 xref:../03-disko/index.adoc[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. -The rest of the locale settings is best configured from the host or its individual users. diff --git a/docs/content/en-US/01-introduction/index.adoc b/docs/content/en/01-introduction/index.adoc similarity index 100% rename from docs/content/en-US/01-introduction/index.adoc rename to docs/content/en/01-introduction/index.adoc diff --git a/docs/content/en-US/02-lay-of-the-land/01-prerequisites/index.adoc b/docs/content/en/02-lay-of-the-land/01-prerequisites/index.adoc similarity index 100% rename from docs/content/en-US/02-lay-of-the-land/01-prerequisites/index.adoc rename to docs/content/en/02-lay-of-the-land/01-prerequisites/index.adoc diff --git a/docs/content/en-US/02-lay-of-the-land/02-project-structure/index.adoc b/docs/content/en/02-lay-of-the-land/02-project-structure/index.adoc similarity index 100% rename from docs/content/en-US/02-lay-of-the-land/02-project-structure/index.adoc rename to docs/content/en/02-lay-of-the-land/02-project-structure/index.adoc diff --git a/docs/content/en-US/02-lay-of-the-land/03-whats-in-my-flake/index.adoc b/docs/content/en/02-lay-of-the-land/03-whats-in-my-flake/index.adoc similarity index 100% rename from docs/content/en-US/02-lay-of-the-land/03-whats-in-my-flake/index.adoc rename to docs/content/en/02-lay-of-the-land/03-whats-in-my-flake/index.adoc diff --git a/docs/content/en-US/02-lay-of-the-land/04-channels-support/index.adoc b/docs/content/en/02-lay-of-the-land/04-channels-support/index.adoc similarity index 100% rename from docs/content/en-US/02-lay-of-the-land/04-channels-support/index.adoc rename to docs/content/en/02-lay-of-the-land/04-channels-support/index.adoc diff --git a/docs/content/en-US/02-lay-of-the-land/05-what-should-not-be-here/index.adoc b/docs/content/en/02-lay-of-the-land/05-what-should-not-be-here/index.adoc similarity index 100% rename from docs/content/en-US/02-lay-of-the-land/05-what-should-not-be-here/index.adoc rename to docs/content/en/02-lay-of-the-land/05-what-should-not-be-here/index.adoc diff --git a/docs/content/en-US/02-lay-of-the-land/06-the-ci-server/index.adoc b/docs/content/en/02-lay-of-the-land/06-the-ci-server/index.adoc similarity index 100% rename from docs/content/en-US/02-lay-of-the-land/06-the-ci-server/index.adoc rename to docs/content/en/02-lay-of-the-land/06-the-ci-server/index.adoc diff --git a/docs/content/en-US/03-project-specific-setup/01-declarative-host-management/index.adoc b/docs/content/en/03-project-specific-setup/01-declarative-host-management/index.adoc similarity index 100% rename from docs/content/en-US/03-project-specific-setup/01-declarative-host-management/index.adoc rename to docs/content/en/03-project-specific-setup/01-declarative-host-management/index.adoc diff --git a/docs/content/en-US/03-project-specific-setup/02-declarative-user-management/index.adoc b/docs/content/en/03-project-specific-setup/02-declarative-user-management/index.adoc similarity index 100% rename from docs/content/en-US/03-project-specific-setup/02-declarative-user-management/index.adoc rename to docs/content/en/03-project-specific-setup/02-declarative-user-management/index.adoc diff --git a/docs/content/en-US/03-project-specific-setup/03-secrets-management/assets/attach-sops-prefix.nix b/docs/content/en/03-project-specific-setup/03-secrets-management/assets/attach-sops-prefix.nix similarity index 100% rename from docs/content/en-US/03-project-specific-setup/03-secrets-management/assets/attach-sops-prefix.nix rename to docs/content/en/03-project-specific-setup/03-secrets-management/assets/attach-sops-prefix.nix diff --git a/docs/content/en-US/03-project-specific-setup/03-secrets-management/assets/get-secrets.nix b/docs/content/en/03-project-specific-setup/03-secrets-management/assets/get-secrets.nix similarity index 100% rename from docs/content/en-US/03-project-specific-setup/03-secrets-management/assets/get-secrets.nix rename to docs/content/en/03-project-specific-setup/03-secrets-management/assets/get-secrets.nix diff --git a/docs/content/en-US/03-project-specific-setup/03-secrets-management/index.adoc b/docs/content/en/03-project-specific-setup/03-secrets-management/index.adoc similarity index 100% rename from docs/content/en-US/03-project-specific-setup/03-secrets-management/index.adoc rename to docs/content/en/03-project-specific-setup/03-secrets-management/index.adoc diff --git a/docs/content/en-US/03-project-specific-setup/04-custom-firefox-addons/index.adoc b/docs/content/en/03-project-specific-setup/04-custom-firefox-addons/index.adoc similarity index 100% rename from docs/content/en-US/03-project-specific-setup/04-custom-firefox-addons/index.adoc rename to docs/content/en/03-project-specific-setup/04-custom-firefox-addons/index.adoc diff --git a/docs/content/en/04-nixos-modules/01-workflows/index.adoc b/docs/content/en/04-nixos-modules/01-workflows/index.adoc new file mode 100644 index 00000000..000f8c24 --- /dev/null +++ b/docs/content/en/04-nixos-modules/01-workflows/index.adoc @@ -0,0 +1,56 @@ +--- +title: Workflows +--- += Workflows + +Workflows are all-encompassing NixOS modules for dictating how you interact with your computer/device/whatever. +Basically, this is where certain things are set such as your GNOME desktop environment settings, your dolled up standalone window manager setup, or an oddball audio-only desktop interface. + +[NOTE] +==== +Take note that they are considered as private modules so if you're not foodogsquared, you shouldn't use it. +==== + +The workflow namespace mainly contains the `enable` option where you can enable more than one workflows like in the following code. + +[source, nix] +---- +{ config, lib, pkgs, ... }: + +{ + workflows.enable = [ + "a-happy-gnome" + "beepeedobolyuessemm" + ]; +} +---- + +However, enabling workflows shouldn't be taken lightly as they are quite pervasive with what they can configure. + +* Enabling (and/or disabling) system services such as the preferred network manager. + +* Modifying the list of installed applications. +This is especially more prevalent when you enable more than workflow module. + +* Setting up programs with custom configurations which could cause conflicts with the defaults (upstream or from nixpkgs) or with another workflow module. + +Additionally, you can make your workflow module configurable by setting up options in `workflows.workflows.` namespace. + +[chat, foodogsquared] +==== +By organizing the workflow modules this way, you can easily create your desktop rices without overlapping system settings. +Bless the Nix module system! +==== + +[chat, foodogsquared, state=cheeky] +==== +Whether those rices are worth posting to Unix ricing communities is up to you though. +==== + +[chat, Ezran, state=disappointed, role=reversed] +==== +Whippersnappers with your "riced"-up systems... +==== + + +include::../../../../../modules/nixos/_private/workflows/README.adoc#design-constraints[] diff --git a/docs/content/en-US/04-nixos-modules/02-disko/index.adoc b/docs/content/en/04-nixos-modules/02-disko/index.adoc similarity index 100% rename from docs/content/en-US/04-nixos-modules/02-disko/index.adoc rename to docs/content/en/04-nixos-modules/02-disko/index.adoc diff --git a/docs/content/en-US/04-nixos-modules/03-host-specific-modules/index.adoc b/docs/content/en/04-nixos-modules/03-host-specific-modules/index.adoc similarity index 100% rename from docs/content/en-US/04-nixos-modules/03-host-specific-modules/index.adoc rename to docs/content/en/04-nixos-modules/03-host-specific-modules/index.adoc diff --git a/docs/content/en-US/05-home-manager/index.adoc b/docs/content/en/05-home-manager/index.adoc similarity index 100% rename from docs/content/en-US/05-home-manager/index.adoc rename to docs/content/en/05-home-manager/index.adoc diff --git a/docs/content/en-US/06-using-parts-of-my-configuration/index.adoc b/docs/content/en/06-using-parts-of-my-configuration/index.adoc similarity index 100% rename from docs/content/en-US/06-using-parts-of-my-configuration/index.adoc rename to docs/content/en/06-using-parts-of-my-configuration/index.adoc diff --git a/docs/content/en-US/07-faq/index.adoc b/docs/content/en/07-faq/index.adoc similarity index 100% rename from docs/content/en-US/07-faq/index.adoc rename to docs/content/en/07-faq/index.adoc diff --git a/docs/content/en-US/08-acknowledgement/index.adoc b/docs/content/en/08-acknowledgement/index.adoc similarity index 100% rename from docs/content/en-US/08-acknowledgement/index.adoc rename to docs/content/en/08-acknowledgement/index.adoc diff --git a/docs/content/en-US/09-copyright/index.adoc b/docs/content/en/09-copyright/index.adoc similarity index 100% rename from docs/content/en-US/09-copyright/index.adoc rename to docs/content/en/09-copyright/index.adoc diff --git a/docs/content/en-US/_index.adoc b/docs/content/en/_index.adoc similarity index 100% rename from docs/content/en-US/_index.adoc rename to docs/content/en/_index.adoc diff --git a/docs/content/en-US/menu.adoc b/docs/content/en/menu.adoc similarity index 100% rename from docs/content/en-US/menu.adoc rename to docs/content/en/menu.adoc