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

Merge pull request 'Docs: fix all broken anchor references' (#2679) from hsjobeki/clan-core:hsjobeki-main into main

Browse Source
This commit is contained in:
clan-bot
2024-12-31 14:47:12 +00:00
parent 8254ad4c3c db5f934869
commit 5559b39f87
4 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
clanModules/syncthing/README.md
View File

@@ -19,7 +19,7 @@ We recommend configuring this module as an sync-service through the provided opt
- **Share Folders**: Select folders to share with connected devices and configure permissions and synchronization parameters.
!!! info
Clan automatically discovers other devices. Automatic discovery requires one machine to be an [introducer](#clansyncthingintroducer)
Clan automatically discovers other devices. Automatic discovery requires one machine to be an [introducer](#clan.syncthing.introducer)
If that is not the case you can add the other device by its Device ID manually.
You can find and share Device IDs under the "Add Device" button in the Web GUI. (`127.0.0.1:8384`)

4
docs/site/clanmodules/index.md
View File

@@ -9,7 +9,7 @@ This site will guide you through authoring your first module. Explaining which c
!!! Tip
External ClanModules can be ad-hoc loaded via [`clan.inventory.modules`](../reference/nix-api/inventory.md#modules)
External ClanModules can be ad-hoc loaded via [`clan.inventory.modules`](../reference/nix-api/inventory.md#inventory.modules)
## Bootstrapping the `clanModule`
@@ -48,7 +48,7 @@ clanModules/borgbackup
=== "User module"
If the module should be ad-hoc loaded.
It can be made avilable in any project via the [`clan.inventory.modules`](../reference/nix-api/inventory.md#modules) attribute.
It can be made avilable in any project via the [`clan.inventory.modules`](../reference/nix-api/inventory.md#inventory.modules) attribute.
```nix title="flake.nix"
# ...

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

@@ -16,7 +16,7 @@ Clan currently offers the following methods to configure machines:
- machines/`machine_name`/configuration.nix (`autoincluded` if it exists)
See the complete [list](../manual/adding-machines.md#automatic-register) of auto-loaded files.
See the complete [list](../manual/adding-machines.md#automatic-registration) of auto-loaded files.
???+ Note "Used by CLI & UI"

12
lib/inventory/build-inventory/interface.nix
View File

@@ -157,7 +157,7 @@ in
description = ''
Tags of the inventory are used to group machines together.
It is recommended to use [`machine.tags`](#machinestags) to define the tags of the machines.
It is recommended to use [`machine.tags`](#inventory.machines.tags) to define the tags of the machines.
This can be used to define custom tags that are either statically set or dynamically computed.
@@ -185,7 +185,7 @@ in
allButFoo is a computed tag. It will be added to all machines except 'foo'
`all` is a predefined tag. See the docs of [`tags.all`](#tagsall).
`all` is a predefined tag. See the docs of [`tags.all`](#inventory.tags.all).
```nix
# inventory.tags ↓ ↓ inventory.machines
@@ -295,7 +295,7 @@ in
!!! Note
Services MUST be added to machines via `roles` exclusively.
See [`roles.<rolename>.machines`](#servicesrolesmachines) or [`roles.<rolename>.tags`](#servicesrolesmachines) for more information.
See [`roles.<rolename>.machines`](#inventory.services.roles.machines) or [`roles.<rolename>.tags`](#inventory.services.roles.tags) for more information.
'';
default = { };
type = types.attrsOf (
@@ -377,7 +377,7 @@ in
description = ''
Additional configuration of the specific machine.
See how [`service.<name>.<name>.config`](#servicesconfig) works in general for further information.
See how [`service.<name>.<name>.config`](#inventory.services.config) works in general for further information.
'';
};
}
@@ -396,7 +396,7 @@ in
The machines are referenced by their `attributeName` in the `inventory.machines` attribute set.
Memberships are decaled here to determine which machines are part of the service.
Memberships are declared here to determine which machines are part of the service.
Alternatively, `tags` can be used to determine the membership, more dynamically.
'';
@@ -416,7 +416,7 @@ in
description = ''
Additional configuration of the specific role.
See how [`service.<name>.<name>.config`](#servicesconfig) works in general for further information.
See how [`service.<name>.<name>.config`](#inventory.services.config) works in general for further information.
'';
};
options.extraModules = extraModulesOption;