Update project metadata template (ngi-nix#588)

Co-authored-by: eljamm <[email protected]>

Author: imincik

templates/project/default.nix

@@ -3,45 +3,79 @@
   pkgs,
   sources,
 }@args:
+
 {
   # NOTE:
-  # - Check `projects/models.nix` for a more detailed project structure
   # - Each program/service must have at least one example
   # - Set attributes to `null` to indicate that they're needed, but not available
   metadata = {
-    summary = "";
+    summary = "Short summary that describes the project";
     subgrants = [
-      "FooBar"
-      "FooBar-cli"
+      # 1. Navigate to the [NLnet project list](https://nlnet.nl/project/)
+      # 2. Enter the project name in the search bar
+      # 3. Review all the entries returned by the search
+      # 4. Collect the links to entries that relate to the project
+      #
+      # For example, for a project called `Foobar`, this can be something like:
+      #
+      #   - https://nlnet.nl/project/Foobar
+      #   - https://nlnet.nl/project/Foobar-mobile
+      #
+      # The subgrants will then be:
+      #
+      "Foobar"
+      "Foobar-mobile"
     ];
   };
 
+  # NOTE: Replace `_programName_` with the actual program name
   nixos.modules.programs = {
-    foobar = {
-      name = "foobar";
-      module = ./module.nix;
-      examples.foobar = {
-        module = ./example.nix;
+    _programName_ = {
+      name = "program name";
+      module = ./programs/_programName_/module.nix;
+      examples.basic = {
+        module = ./programs/_programName_/examples/basic.nix;
         description = "";
-        tests.basic = ./test.nix;
+        tests.basic = ./programs/_programName_/tests/basic.nix;
       };
+      # Add relevant links to the program, for example:
       links = {
         build = {
-          text = "FooBar Documentation";
-          url = "https://foo.bar/build";
+          text = "Build from source";
+          url = "<URL>";
         };
         test = {
-          text = "FooBar Documentation";
-          url = "https://foo.bar/test";
+          text = "Test instructions";
+          url = "<URL>";
         };
       };
     };
 
-    # needed, but not available
+    # Needed, but not available
     foobar-cli = null;
   };
 
-  # NOTE: same structure as programs
+  # NOTE: Replace `_serviceName_` with the actual service name
   nixos.modules.services = {
+    _serviceName_ = {
+      name = "service name";
+      module = ./services/_serviceName_/module.nix;
+      examples.basic = {
+        module = ./services/_serviceName_/examples/basic.nix;
+        description = "";
+        tests.basic = ./services/_serviceName_/tests/basic.nix;
+      };
+      # Add relevant links to the service, for example:
+      links = {
+        build = {
+          text = "Build from source";
+          url = "<URL>";
+        };
+        test = {
+          text = "Test instructions";
+          url = "<URL>";
+        };
+      };
+    };
   };
 }

templates/project/example.nix

@@ -0,0 +1,5 @@
+{ ... }:
+
+{
+  services._programName_.enable = true;
+}

templates/project/module.nix

@@ -0,0 +1,14 @@
+{
+  config,
+  lib,
+  pkgs,
+  ...
+}:
+let
+  cfg = config.programs._programName_;
+in
+{
+  options.programs._programName_ = {
+    enable = lib.mkEnableOption "program name";
+  };
+}

templates/project/programs/_programName_/examples/basic.nix

@@ -2,17 +2,18 @@
   sources,
   ...
 }:
+
 {
-  name = "foobar";
+  name = "Program Name";
 
   nodes = {
     machine =
       { ... }:
       {
         imports = [
           sources.modules.ngipkgs
-          sources.modules.programs.foobar
-          sources.examples.Foobar.foobar
+          sources.modules.services._programName_
+          sources.examples._ProjectName_._programName_
         ];
       };
   };
@@ -22,6 +23,6 @@
     ''
       start_all()
 
-      machine.succeed("foobar --help")
+      machine.succeed()
     '';
 }

templates/project/programs/_programName_/module.nix

@@ -0,0 +1,5 @@
+{ ... }:
+
+{
+  services._serviceName_.enable = true;
+}

templates/project/test.nix renamed to templates/project/programs/_programName_/tests/basic.nix

@@ -0,0 +1,14 @@
+{
+  config,
+  lib,
+  pkgs,
+  ...
+}:
+let
+  cfg = config.services._serviceName_;
+in
+{
+  options.services._serviceName_ = {
+    enable = lib.mkEnableOption "service name";
+  };
+}

templates/project/services/_serviceName_/examples/basic.nix

@@ -0,0 +1,28 @@
+{
+  sources,
+  ...
+}:
+
+{
+  name = "Service Name";
+
+  nodes = {
+    machine =
+      { ... }:
+      {
+        imports = [
+          sources.modules.ngipkgs
+          sources.modules.services._serviceName_
+          sources.examples._ProjectName_._serviceName_
+        ];
+      };
+  };
+
+  testScript =
+    { nodes, ... }:
+    ''
+      start_all()
+
+      machine.succeed()
+    '';
+}