From 53dcc4e332c6ca8dbca91397796574197b61c770 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Tue, 20 May 2025 18:34:33 +0200 Subject: [PATCH] docs: replace outdates reference links to 'guides' in the cli --- pkgs/clan-cli/clan_cli/__init__.py | 20 ++++++++++---------- pkgs/clan-cli/clan_cli/facts/cli.py | 8 ++++---- pkgs/clan-cli/clan_cli/machines/cli.py | 8 ++++---- pkgs/clan-cli/clan_cli/machines/machines.py | 2 +- pkgs/clan-cli/clan_cli/state/__init__.py | 2 +- pkgs/clan-cli/clan_cli/vars/cli.py | 2 +- templates/clan/flake-parts/flake.nix | 2 +- templates/clan/new-clan/flake.nix | 2 +- 8 files changed, 23 insertions(+), 23 deletions(-) diff --git a/pkgs/clan-cli/clan_cli/__init__.py b/pkgs/clan-cli/clan_cli/__init__.py index b95c5baa1..f70401827 100644 --- a/pkgs/clan-cli/clan_cli/__init__.py +++ b/pkgs/clan-cli/clan_cli/__init__.py @@ -119,7 +119,7 @@ def create_parser(prog: str | None = None) -> argparse.ArgumentParser: description="The clan cli tool", epilog=( 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")} """ ), @@ -171,7 +171,7 @@ Examples: The backup to restore for the machine [MACHINE] with the configured [PROVIDER] 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, @@ -190,7 +190,7 @@ Examples: 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. -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, @@ -208,7 +208,7 @@ Examples: $ clan flash write mymachine --disk main /dev/sd --ssh-pubkey ~/.ssh/id_rsa.pub Will flash the machine 'mymachine' to the disk '/dev/sd' 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, @@ -235,7 +235,7 @@ Examples: the json string. [JSON] can either be a json formatted string itself, or point 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, @@ -259,7 +259,7 @@ Examples: $ clan secrets get [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, @@ -296,7 +296,7 @@ Examples: This is especially useful for resetting certain passwords while leaving the rest 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, @@ -334,7 +334,7 @@ Examples: This is especially useful for resetting certain passwords while leaving the rest 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, @@ -364,7 +364,7 @@ Examples: If the `--target-host` flag is omitted will try to find host information by 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, @@ -427,7 +427,7 @@ Examples: $ clan state list [MACHINE] 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, diff --git a/pkgs/clan-cli/clan_cli/facts/cli.py b/pkgs/clan-cli/clan_cli/facts/cli.py index 9009da79d..d8a7447ab 100644 --- a/pkgs/clan-cli/clan_cli/facts/cli.py +++ b/pkgs/clan-cli/clan_cli/facts/cli.py @@ -31,7 +31,7 @@ Examples: 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, @@ -61,7 +61,7 @@ Examples: 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, @@ -101,7 +101,7 @@ Examples: This is especially useful for resetting certain passwords while leaving the rest 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, @@ -125,7 +125,7 @@ Examples: $ clan facts upload [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, diff --git a/pkgs/clan-cli/clan_cli/machines/cli.py b/pkgs/clan-cli/clan_cli/machines/cli.py index 10d88776e..9ddb53fdf 100644 --- a/pkgs/clan-cli/clan_cli/machines/cli.py +++ b/pkgs/clan-cli/clan_cli/machines/cli.py @@ -37,7 +37,7 @@ Examples: To exclude machines being updated `clan.deployment.requireExplicitUpdate = true;` 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, @@ -93,7 +93,7 @@ Examples: $ 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]`. -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 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 more detailed information, visit: https://docs.clan.lol/getting-started/deploy +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/guides/getting-started/deploy """ ), formatter_class=argparse.RawTextHelpFormatter, diff --git a/pkgs/clan-cli/clan_cli/machines/machines.py b/pkgs/clan-cli/clan_cli/machines/machines.py index 71a725f57..fd2fb87bb 100644 --- a/pkgs/clan-cli/clan_cli/machines/machines.py +++ b/pkgs/clan-cli/clan_cli/machines/machines.py @@ -93,7 +93,7 @@ class Machine: msg = f"'targetHost' is not set for machine '{self.name}'" raise ClanError( 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 diff --git a/pkgs/clan-cli/clan_cli/state/__init__.py b/pkgs/clan-cli/clan_cli/state/__init__.py index c68569013..3ad27b0c0 100644 --- a/pkgs/clan-cli/clan_cli/state/__init__.py +++ b/pkgs/clan-cli/clan_cli/state/__init__.py @@ -29,7 +29,7 @@ def register_parser(parser: argparse.ArgumentParser) -> None: 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, diff --git a/pkgs/clan-cli/clan_cli/vars/cli.py b/pkgs/clan-cli/clan_cli/vars/cli.py index ae0303ea9..91a4bc3ee 100644 --- a/pkgs/clan-cli/clan_cli/vars/cli.py +++ b/pkgs/clan-cli/clan_cli/vars/cli.py @@ -197,7 +197,7 @@ Examples: $ clan vars upload [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, diff --git a/templates/clan/flake-parts/flake.nix b/templates/clan/flake-parts/flake.nix index 60c7982ad..18a1bb00d 100644 --- a/templates/clan/flake-parts/flake.nix +++ b/templates/clan/flake-parts/flake.nix @@ -19,7 +19,7 @@ "aarch64-darwin" ]; imports = [ inputs.clan-core.flakeModules.default ]; - # https://docs.clan.lol/getting-started/flake-parts/ + # https://docs.clan.lol/guides/getting-started/flake-parts/ clan = { meta.name = "__CHANGE_ME__"; # Ensure this is unique among all clans you want to use. diff --git a/templates/clan/new-clan/flake.nix b/templates/clan/new-clan/flake.nix index 74be24c73..3459ee14c 100644 --- a/templates/clan/new-clan/flake.nix +++ b/templates/clan/new-clan/flake.nix @@ -14,7 +14,7 @@ # All machines in ./machines will be imported. # 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> Edit ./machines//configuration.nix to your liking. machines = {