From 241cca5b7067a6eca725056231020b95bb833e4c Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Tue, 25 Jun 2024 13:58:38 +0200 Subject: [PATCH] Docs: rename clanName to just name --- docs/site/getting-started/configure.md | 6 +++--- docs/site/getting-started/flake-parts.md | 8 ++++---- flake.nix | 2 +- pkgs/clan-cli/tests/test_flake_with_core/flake.nix | 2 +- .../tests/test_flake_with_core_and_pass/flake.nix | 2 +- .../tests/test_flake_with_core_dynamic_machines/flake.nix | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/site/getting-started/configure.md b/docs/site/getting-started/configure.md index 8c3f0ab2..1b872b24 100644 --- 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 = { diff --git a/docs/site/getting-started/flake-parts.md b/docs/site/getting-started/flake-parts.md index 1ed3d883..69ad2928 100644 --- 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; - + }; }; }; diff --git a/flake.nix b/flake.nix index 341c5b84..698567bd 100644 --- a/flake.nix +++ b/flake.nix @@ -31,7 +31,7 @@ { ... }: { clan = { - # meta.name = "clan-core"; + meta.name = "clan-core"; directory = self; }; systems = [ diff --git a/pkgs/clan-cli/tests/test_flake_with_core/flake.nix b/pkgs/clan-cli/tests/test_flake_with_core/flake.nix index 140deea7..63e71c4c 100644 --- 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, ... }: diff --git 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 index ed869336..457909cb 100644 --- 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, ... }: diff --git 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 index e10e244d..1d27ca39 100644 --- 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");