DavHau/clan-core
1
0
Fork 0
forked from clan/clan-core
Code Pull Requests Activity

documentation: remove references to Icons for introductory material

Browse Source 
The icons are not yet used in this path.
This is unneccessary overhead for new users, with no payoff yet.
This commit is contained in:
a-kenji 2024-05-21 11:16:12 +02:00
parent 6ebfd29c87
commit 7aa85d8aaf
3 changed files with 0 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/site/getting-started/configure.md
View File

@ -5,10 +5,6 @@
In the `flake.nix` file:
- [x] set a unique `clanName`.
- [ ] set `clanIcon` (optional)
- [ ] Set `machineIcon` per machine (optional)
These icons will be used by our future GUI.
=== "**buildClan**"
@ -16,16 +12,12 @@ These icons will be used by our future GUI.
buildClan {
# Set a unique name
clanName = "Lobsters";
# Optional, a path to an image file
clanIcon = ./path/to/file;
# Should usually point to the directory of flake.nix
directory = ./.;
machines = {
jon = {
# ...
# Optional, a path to an image file
clanCore.machineIcon = ./path/to/file;
};
# ...
}
@ -40,14 +32,10 @@ These icons will be used by our future GUI.
clan = {
# Set a unique name
clanName = "Lobsters";
# Optional, a path to an image file
clanIcon = ./path/to/file;
machines = {
jon = {
# ...
# Optional, a path to an image file
clanCore.machineIcon = ./path/to/file;
};
# ...
}

1
docs/site/getting-started/flake-parts.md
View File

@ -73,7 +73,6 @@ Below is a guide on how to structure this in your flake.nix:
# ... more modules
];
nixpkgs.hostPlatform = "x86_64-linux";
clanCore.machineIcon = null; # Optional, a path to an image file
# Set this for clan commands use ssh i.e. `clan machines update`
clan.networking.targetHost = pkgs.lib.mkDefault "root@jon";

5
templates/new-clan/flake.nix
View File

@ -12,7 +12,6 @@
clan = clan-core.lib.buildClan {
directory = self;
clanName = "__CHANGE_ME__"; # Ensure this is internet wide unique.
clanIcon = null; # Optional, a path to an image file
# Prerequisite: boot into the installer
# See: https://docs.clan.lol/getting-started/installer
@ -28,8 +27,6 @@
nixpkgs.hostPlatform = system;
clanCore.machineIcon = null; # Optional, a path to an image file
# Set this for clan commands use ssh i.e. `clan machines update`
# If you change the hostname, you need to update this line to root@<new-hostname>
# This only works however if you have avahi running on your admin machine else use IP
@ -60,8 +57,6 @@
nixpkgs.hostPlatform = system;
clanCore.machineIcon = null; # Optional, a path to an image file
# Set this for clan commands use ssh i.e. `clan machines update`
# If you change the hostname, you need to update this line to root@<new-hostname>
# This only works however if you have avahi running on your admin machine else use IP