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

docs: fix clan-core should be called clan.core

Browse Source 
Consistent with the module name
This commit is contained in:
Johannes Kirschbauer
2025-05-20 18:33:40 +02:00
parent c34b693a64
commit a9ed972834
5 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/nix/render_options/__init__.py
View File

@@ -297,7 +297,7 @@ def produce_clan_core_docs() -> None:
core_outputs: dict[str, str] = {} core_outputs: dict[str, str] = {}
with CLAN_CORE_DOCS.open() as f: with CLAN_CORE_DOCS.open() as f:
options: dict[str, dict[str, Any]] = json.load(f) options: dict[str, dict[str, Any]] = json.load(f)
module_name = "clan-core" module_name = "clan.core"
transform = {n.replace("clan.core.", ""): v for n, v in options.items()} transform = {n.replace("clan.core.", ""): v for n, v in options.items()}
split = split_options_by_root(transform) split = split_options_by_root(transform)

2
docs/site/guides/getting-started/secrets.md
View File

@@ -3,7 +3,7 @@ Clan enables encryption of secrets (such as passwords & keys) ensuring security
By default, Clan uses the [sops](https://github.com/getsops/sops) format By default, Clan uses the [sops](https://github.com/getsops/sops) format
and integrates with [sops-nix](https://github.com/Mic92/sops-nix) on NixOS machines. and integrates with [sops-nix](https://github.com/Mic92/sops-nix) on NixOS machines.
Clan can also be configured to be used with other secret store [backends](https://docs.clan.lol/reference/clan-core/vars/#clan.core.vars.settings.secretStore). Clan can also be configured to be used with other secret store [backends](../../reference/clan.core/vars.md#clan.core.vars.settings.secretStore).
This guide will walk you through: This guide will walk you through:

2
docs/site/guides/migrations/migration-facts-vars.md
View File

@@ -5,7 +5,7 @@ For a high level overview about `vars` see our [blog post](https://clan.lol/blog
This guide will help you migrate your modules that still use our [`facts`](../../guides/secrets.md) backend This guide will help you migrate your modules that still use our [`facts`](../../guides/secrets.md) backend
to the [`vars`](../../guides/vars-backend.md) backend. to the [`vars`](../../guides/vars-backend.md) backend.
The `vars` [module](../../reference/clan-core/vars.md) and the clan [command](../../reference/cli/vars.md) work in tandem, they should ideally be kept in sync. The `vars` [module](../../reference/clan.core/vars.md) and the clan [command](../../reference/cli/vars.md) work in tandem, they should ideally be kept in sync.
## Keep Existing Values ## Keep Existing Values

4
docs/site/guides/vars-backend.md
View File

@@ -7,7 +7,7 @@ Defining a linux user's password via the nixos configuration previously required
In this example, we will guide you through automating that interaction using clan `vars`. In this example, we will guide you through automating that interaction using clan `vars`.
For a more general explanation of what clan vars are and how it works, see the intro of the [Reference Documentation for vars](https://docs.clan.lol/reference/clan-core/vars/) For a more general explanation of what clan vars are and how it works, see the intro of the [Reference Documentation for vars](../reference/clan.core/vars.md)
This guide assumes This guide assumes
- clan is set up already (see [Getting Started](../guides/getting-started/index.md)) - clan is set up already (see [Getting Started](../guides/getting-started/index.md))
@@ -147,5 +147,5 @@ Updated var root-password/password-hash
## Further Reading ## Further Reading
- [Reference Documentation for `clan.core.vars` nixos options](../reference/clan-core/vars.md) - [Reference Documentation for `clan.core.vars` nixos options](../reference/clan.core/vars.md)
- [Reference Documentation for the `clan vars` cli command](../reference/cli/vars.md) - [Reference Documentation for the `clan vars` cli command](../reference/cli/vars.md)

2
docs/site/index.md
View File

@@ -70,7 +70,7 @@ hide:
An overview of available service modules An overview of available service modules
- [Core](./reference/clan-core/index.md) - [Core](./reference/clan.core/index.md)
--- ---