yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: replace outdates reference links to 'guides' in the cli

Browse Source
This commit is contained in:
Johannes Kirschbauer
2025-05-20 18:34:33 +02:00
parent 8ad35c1bee
commit d3fc1725f0
8 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
pkgs/clan-cli/clan_cli/__init__.py
View File

@@ -119,7 +119,7 @@ def create_parser(prog: str | None = None) -> argparse.ArgumentParser:
description="The clan cli tool", description="The clan cli tool",
epilog=( epilog=(
f""" f"""
Online reference for the clan cli tool: {help_hyperlink("cli reference", "https://docs.clan.lol/reference/cli/")} Online reference for the clan cli tool: {help_hyperlink("cli reference", "https://docs.clan.lol/reference/cli")}
For more detailed information, visit: {help_hyperlink("docs", "https://docs.clan.lol")} For more detailed information, visit: {help_hyperlink("docs", "https://docs.clan.lol")}
""" """
), ),
@@ -171,7 +171,7 @@ Examples:
The backup to restore for the machine [MACHINE] with the configured [PROVIDER] The backup to restore for the machine [MACHINE] with the configured [PROVIDER]
with the name [NAME]. with the name [NAME].
For more detailed information visit: {help_hyperlink("backups", "https://docs.clan.lol/getting-started/backups")}. For more detailed information visit: {help_hyperlink("backups", "https://docs.clan.lol/guides/backups")}.
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -190,7 +190,7 @@ Examples:
Will create a new clan flake in the specified directory and create it if it Will create a new clan flake in the specified directory and create it if it
doesn't exist yet. The flake will be created from a default template. doesn't exist yet. The flake will be created from a default template.
For more detailed information, visit: {help_hyperlink("getting-started", "https://docs.clan.lol/getting-started")} For more detailed information, visit: {help_hyperlink("getting-started", "https://docs.clan.lol/guides/getting-started/index.html")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -208,7 +208,7 @@ Examples:
$ clan flash write mymachine --disk main /dev/sd<X> --ssh-pubkey ~/.ssh/id_rsa.pub $ clan flash write mymachine --disk main /dev/sd<X> --ssh-pubkey ~/.ssh/id_rsa.pub
Will flash the machine 'mymachine' to the disk '/dev/sd<X>' with the ssh public key '~/.ssh/id_rsa.pub'. Will flash the machine 'mymachine' to the disk '/dev/sd<X>' with the ssh public key '~/.ssh/id_rsa.pub'.
For more detailed information, visit: {help_hyperlink("getting-started", "https://docs.clan.lol/getting-started/installer")} For more detailed information, visit: {help_hyperlink("getting-started", "https://docs.clan.lol/guides/getting-started/installer")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -235,7 +235,7 @@ Examples:
the json string. [JSON] can either be a json formatted string itself, or point the json string. [JSON] can either be a json formatted string itself, or point
towards a file containing the deployment information towards a file containing the deployment information
For more detailed information, visit: {help_hyperlink("deploy", "https://docs.clan.lol/getting-started/deploy")} For more detailed information, visit: {help_hyperlink("deploy", "https://docs.clan.lol/guides/getting-started/deploy")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -259,7 +259,7 @@ Examples:
$ clan secrets get [SECRET] $ clan secrets get [SECRET]
Will display the content of the specified secret. Will display the content of the specified secret.
For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")} For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/guides/getting-started/secrets")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -296,7 +296,7 @@ Examples:
This is especially useful for resetting certain passwords while leaving the rest This is especially useful for resetting certain passwords while leaving the rest
of the facts for a machine in place. of the facts for a machine in place.
For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")} For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/guides/getting-started/secrets")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -334,7 +334,7 @@ Examples:
This is especially useful for resetting certain passwords while leaving the rest This is especially useful for resetting certain passwords while leaving the rest
of the vars for a machine in place. of the vars for a machine in place.
For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")} For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/guides/getting-started/secrets")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -364,7 +364,7 @@ Examples:
If the `--target-host` flag is omitted will try to find host information by If the `--target-host` flag is omitted will try to find host information by
checking the deployment configuration inside the specified machine. checking the deployment configuration inside the specified machine.
For more detailed information, visit: {help_hyperlink("deploy", "https://docs.clan.lol/getting-started/deploy")} For more detailed information, visit: {help_hyperlink("deploy", "https://docs.clan.lol/guides/getting-started/deploy")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -427,7 +427,7 @@ Examples:
$ clan state list [MACHINE] $ clan state list [MACHINE]
List state of the machines managed by Clan. List state of the machines managed by Clan.
For more detailed information, visit: {help_hyperlink("getting-started", "https://docs.clan.lol/backups")} For more detailed information, visit: {help_hyperlink("getting-started", "https://docs.clan.lol/guides/backups")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,

8
pkgs/clan-cli/clan_cli/facts/cli.py
View File

@@ -31,7 +31,7 @@ Examples:
Will check facts for the specified machine. Will check facts for the specified machine.
For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")} For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/guides/getting-started/secrets")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -61,7 +61,7 @@ Examples:
Will list facts for the specified machine. Will list facts for the specified machine.
For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")} For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/guides/getting-started/secrets")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -101,7 +101,7 @@ Examples:
This is especially useful for resetting certain passwords while leaving the rest This is especially useful for resetting certain passwords while leaving the rest
of the facts for a machine in place. of the facts for a machine in place.
For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")} For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/guides/getting-started/secrets")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -125,7 +125,7 @@ Examples:
$ clan facts upload [MACHINE] $ clan facts upload [MACHINE]
Will upload secrets to a specific machine. Will upload secrets to a specific machine.
For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")} For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/guides/getting-started/secrets")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,

8
pkgs/clan-cli/clan_cli/machines/cli.py
View File

@@ -37,7 +37,7 @@ Examples:
To exclude machines being updated `clan.deployment.requireExplicitUpdate = true;` To exclude machines being updated `clan.deployment.requireExplicitUpdate = true;`
can be set in the machine config. can be set in the machine config.
For more detailed information, visit: https://docs.clan.lol/getting-started/deploy For more detailed information, visit: https://docs.clan.lol/guides/getting-started/deploy
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
@@ -93,7 +93,7 @@ Examples:
$ clan machines update-hardware-config [MACHINE] [TARGET_HOST] $ clan machines update-hardware-config [MACHINE] [TARGET_HOST]
Will generate hardware specifics for the the specified `[TARGET_HOST]` and place the result in hardware.nix for the given machine `[MACHINE]`. Will generate hardware specifics for the the specified `[TARGET_HOST]` and place the result in hardware.nix for the given machine `[MACHINE]`.
For more detailed information, visit: https://docs.clan.lol/getting-started/configure/#machine-configuration For more detailed information, visit: https://docs.clan.lol/guides/getting-started/configure/#machine-configuration
""" """
), ),
@@ -123,8 +123,8 @@ Examples:
Will install the specified machine [MACHINE] to the host exposed by Will install the specified machine [MACHINE] to the host exposed by
the deployment information of the [JSON] deployment string. the deployment information of the [JSON] deployment string.
For information on how to set up the installer see: https://docs.clan.lol/getting-started/installer/ For information on how to set up the installer see: https://docs.clan.lol/guides/getting-started/installer/
For more detailed information, visit: https://docs.clan.lol/getting-started/deploy For more detailed information, visit: https://docs.clan.lol/guides/getting-started/deploy
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,

2
pkgs/clan-cli/clan_cli/machines/machines.py
View File

@@ -93,7 +93,7 @@ class Machine:
msg = f"'targetHost' is not set for machine '{self.name}'" msg = f"'targetHost' is not set for machine '{self.name}'"
raise ClanError( raise ClanError(
msg, msg,
description="See https://docs.clan.lol/getting-started/deploy/#setting-the-target-host for more information.", description="See https://docs.clan.lol/guides/getting-started/deploy/#setting-the-target-host for more information.",
) )
return val return val

2
pkgs/clan-cli/clan_cli/state/__init__.py
View File

@@ -29,7 +29,7 @@ def register_parser(parser: argparse.ArgumentParser) -> None:
List state of the machine [MACHINE] managed by Clan. List state of the machine [MACHINE] managed by Clan.
For more detailed information, visit: https://docs.clan.lol/getting-started/backups/ For more detailed information, visit: https://docs.clan.lol/guides/backups
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,

2
pkgs/clan-cli/clan_cli/vars/cli.py
View File

@@ -197,7 +197,7 @@ Examples:
$ clan vars upload [MACHINE] $ clan vars upload [MACHINE]
Will upload secrets to a specific machine. Will upload secrets to a specific machine.
For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")} For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/guides/getting-started/secrets")}
""" """
), ),
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,

2
templates/clan/flake-parts/flake.nix
View File

@@ -19,7 +19,7 @@
"aarch64-darwin" "aarch64-darwin"
]; ];
imports = [ inputs.clan-core.flakeModules.default ]; imports = [ inputs.clan-core.flakeModules.default ];
# https://docs.clan.lol/getting-started/flake-parts/ # https://docs.clan.lol/guides/getting-started/flake-parts/
clan = { clan = {
meta.name = "__CHANGE_ME__"; # Ensure this is unique among all clans you want to use. meta.name = "__CHANGE_ME__"; # Ensure this is unique among all clans you want to use.

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

@@ -14,7 +14,7 @@
# All machines in ./machines will be imported. # All machines in ./machines will be imported.
# Prerequisite: boot into the installer. # Prerequisite: boot into the installer.
# See: https://docs.clan.lol/getting-started/installer # See: https://docs.clan.lol/guides/getting-started/installer
# local> mkdir -p ./machines/machine1 # local> mkdir -p ./machines/machine1
# local> Edit ./machines/<machine>/configuration.nix to your liking. # local> Edit ./machines/<machine>/configuration.nix to your liking.
machines = { machines = {