configurations -> examples (#258)

* configurations -> examples

configurations are a legacy name, these really are examples for
consumer-facing documentation.

flake.nix

@@ -80,18 +80,18 @@
     importNgiProjects = {
       pkgs ? {},
       sources ? {
-        configurations = rawNixosConfigurations;
+        examples = rawExamples;
         modules = extendedNixosModules;
       },
     }:
       import ./projects {inherit lib pkgs sources;};
 
-    # The above definition reimports `rawNixosConfigurations` and `extendedNixosModules` into `sources`.
+    # The above definition reimports `rawExamples` and `extendedNixosModules` into `sources`.
     # As configurations and modules are system-agnostic, they are defined by passing `{}` to `importNgiProjects`.
     rawNgiProjects = importNgiProjects {};
 
-    rawNixosConfigurations = flattenAttrsSlash (mapAttrs (_: v: mapAttrs (_: v: v.path) v) (
-      mapAttrByPath ["nixos" "configurations"] {} rawNgiProjects
+    rawExamples = flattenAttrsSlash (mapAttrs (_: v: mapAttrs (_: v: v.path) v) (
+      mapAttrByPath ["nixos" "examples"] {} rawNgiProjects
     ));
 
     rawNixosModules = flattenAttrsDot (lib.foldl recursiveUpdate {} (attrValues (
@@ -107,7 +107,7 @@
     extendedNixosConfigurations =
       mapAttrs
       (_: config: nixosSystem {modules = [config ./dummy.nix] ++ attrValues extendedNixosModules;})
-      rawNixosConfigurations;
+      rawExamples;
 
     # Then, define the system-specific outputs.
     eachDefaultSystemOutputs = flake-utils.lib.eachDefaultSystem (system: let

overview/default.nix

@@ -56,7 +56,7 @@
       filter
       (option: any ((flip hasPrefix) (dottedLoc option)) spec)
       (attrValues options);
-    configurations = project: attrValues (project.nixos.configurations or {});
+    examples = project: attrValues (project.nixos.examples or {});
     packages = project: attrValues (project.packages or {});
   };
 
@@ -113,20 +113,20 @@
         '';
     };
 
-    configurations = rec {
-      one = configuration: ''
+    examples = rec {
+      one = example: ''
         <li>
-          <p>${configuration.description}</p>
+          <p>${example.description}</p>
           ```nix
-        ${readFile configuration.path}
+        ${readFile example.path}
           ```
         </li>
       '';
-      many = configurations:
-        optionalString (!empty configurations)
+      many = examples:
+        optionalString (!empty examples)
         ''
-          <section><details><summary>${heading 3 "Configurations"}</summary><ul>
-          ${concatLines (map one configurations)}
+          <section><details><summary>${heading 3 "Examples"}</summary><ul>
+          ${concatLines (map one examples)}
           </ul></details></section>
         '';
     };
@@ -138,7 +138,7 @@
 
         ${render.packages.many (pick.packages project)}
         ${render.options.many (pick.options project)}
-        ${render.configurations.many (pick.configurations project)}
+        ${render.examples.many (pick.examples project)}
         </details></section>
       '';
       many = projects: concatLines (mapAttrsToList one projects);

projects/Kbin/default.nix

@@ -6,9 +6,9 @@
   packages = {inherit (pkgs) kbin kbin-frontend kbin-backend;};
   nixos = {
     modules.services.kbin = ./service.nix;
-    configurations = {
+    examples = {
       base = {
-        path = ./configuration.nix;
+        path = ./example.nix;
         description = "Basic configuration, mainly used for testing purposes.";
       };
     };

projects/Kbin/test.nix

@@ -20,7 +20,7 @@ in {
         sources.modules.default
         sources.modules."services.kbin"
         sources.modules.unbootable
-        sources.configurations."Kbin/base"
+        sources.examples."Kbin/base"
       ];
 
       unbootable = mkForce false;

projects/Pretalx/default.nix

@@ -10,21 +10,21 @@
   nixos = {
     modules.services.ngi-pretalx = ./service.nix;
     tests.pretalx = import ./test args;
-    configurations = {
+    examples = {
       base = {
-        path = ./config/base.nix;
+        path = ./examples/base.nix;
         description = ''
           Basic configuration for Pretalx, incl. secret management with SOPS, excl. database settings.
         '';
       };
       postgresql = {
-        path = ./config/postgresql.nix;
+        path = ./examples/postgresql.nix;
         description = ''
           Supplementary to `base.nix`, adds database configuration for PostgreSQL.
         '';
       };
       mysql = {
-        path = ./config/mysql.nix;
+        path = ./examples/mysql.nix;
         description = ''
           Supplementary to `base.nix`, adds database configuration for MySQL.
         '';

projects/Pretalx/test/default.nix

@@ -17,8 +17,8 @@ in {
       ...
     }: {
       imports = [
-        sources.configurations."Pretalx/base"
-        sources.configurations."Pretalx/postgresql"
+        sources.examples."Pretalx/base"
+        sources.examples."Pretalx/postgresql"
         sources.modules.default
         sources.modules."services.ngi-pretalx"
         sources.modules.sops-nix