Merge pull request 'Docs: rename clanName to just name' (#1660) from hsjobeki/clan-core:hsjobeki-main into main

2024-06-25 12:25:27 +00:00 · 2024-06-25 12:25:27 +00:00 · 4022c13b31
commit 4022c13b31
parent 25db02368a 241cca5b70
6 changed files with 11 additions and 11 deletions
--- a/docs/site/getting-started/configure.md
+++ b/docs/site/getting-started/configure.md
@ -4,14 +4,14 @@

 In the `flake.nix` file:

- [x] set a unique `clanName`.
+- [x] set a unique `name`.

 === "**buildClan**"

    ```nix title="clan-core.lib.buildClan"
    buildClan {
        # Set a unique name
-        clanName = "Lobsters";
+        meta.name = "Lobsters";
        # Should usually point to the directory of flake.nix
        directory = ./.;

@ -31,7 +31,7 @@ In the `flake.nix` file:
    ```nix title="clan-core.flakeModules.default"
    clan = {
        # Set a unique name
-        clanName = "Lobsters";
+        meta.name = "Lobsters";

        machines = {
            jon = {
--- a/docs/site/getting-started/flake-parts.md
+++ b/docs/site/getting-started/flake-parts.md
@ -16,7 +16,7 @@ inputs = {
  # New flake-parts input
  flake-parts.url = "github:hercules-ci/flake-parts";
  flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs";
-  
+
  clan-core = {
    url = "git+https://git.clan.lol/clan/clan-core";
    inputs.nixpkgs.follows = "nixpkgs"; # Needed if your configuration uses nixpkgs unstable.
@ -35,7 +35,7 @@ After updating your flake inputs, the next step is to import the `clan-core` fla
    inputs@{ flake-parts, ... }:
    flake-parts.lib.mkFlake { inherit inputs; } (
      {
-        # 
+        #
        imports = [
          inputs.clan-core.flakeModules.default
        ];
@ -63,7 +63,7 @@ Below is a guide on how to structure this in your flake.nix:
      # Define your clan
      clan = {
        # Clan wide settings. (Required)
-        clanName = ""; # Ensure to choose a unique name.
+        meta.name = ""; # Ensure to choose a unique name.

        machines = {
          jon = {
@ -84,7 +84,7 @@ Below is a guide on how to structure this in your flake.nix:

            # There needs to be exactly one controller per clan
            clan.networking.zerotier.controller.enable = true;
-            
+
          };
        };
      };
--- a/flake.nix
+++ b/flake.nix
@ -31,7 +31,7 @@
      { ... }:
      {
        clan = {
-          # meta.name = "clan-core";
+          meta.name = "clan-core";
          directory = self;
        };
        systems = [
--- a/pkgs/clan-cli/tests/test_flake_with_core/flake.nix
+++ b/pkgs/clan-cli/tests/test_flake_with_core/flake.nix
@ -10,7 +10,7 @@
    let
      clan = clan-core.lib.buildClan {
        directory = self;
-        clanName = "test_flake_with_core";
+        meta.name = "test_flake_with_core";
        machines = {
          vm1 =
            { lib, ... }:
--- a/pkgs/clan-cli/tests/test_flake_with_core_and_pass/flake.nix
+++ b/pkgs/clan-cli/tests/test_flake_with_core_and_pass/flake.nix
@ -10,7 +10,7 @@
    let
      clan = clan-core.lib.buildClan {
        directory = self;
-        clanName = "test_flake_with_core_and_pass";
+        meta.name = "test_flake_with_core_and_pass";
        machines = {
          vm1 =
            { lib, ... }:
--- a/pkgs/clan-cli/tests/test_flake_with_core_dynamic_machines/flake.nix
+++ b/pkgs/clan-cli/tests/test_flake_with_core_dynamic_machines/flake.nix
@ -10,7 +10,7 @@
    let
      clan = clan-core.lib.buildClan {
        directory = self;
-        clanName = "test_flake_with_core_dynamic_machines";
+        meta.name = "test_flake_with_core_dynamic_machines";
        machines =
          let
            machineModules = builtins.readDir (self + "/machines");