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

docs: fix broken links

Browse Source
This commit is contained in:
Johannes Kirschbauer
2025-10-05 13:59:50 +02:00
parent 75c8feb42a
commit 359582118c
5 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/site/decisions/template.md
View File

@@ -1,6 +1,6 @@
## Decision record template by Michael Nygard ## Decision record template by Michael Nygard
This is the template in [Documenting architecture decisions - Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). This is the template in [Documenting architecture decisions - Michael Nygard](https://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
You can use [adr-tools](https://github.com/npryce/adr-tools) for managing the ADR files. You can use [adr-tools](https://github.com/npryce/adr-tools) for managing the ADR files.
In each ADR file, write these sections: In each ADR file, write these sections:

2
docs/site/index.md
View File

@@ -78,7 +78,7 @@ hide:
/guides/backups/backup-intro/">Backups</a>.</p> /guides/backups/backup-intro/">Backups</a>.</p>
<p>Whether you're running a homelab or maintaining critical computing infrastructure, Clan will help reduce maintenance burden</strong> by allowing a git repository to define your whole network</strong> of computers.</p> <p>Whether you're running a homelab or maintaining critical computing infrastructure, Clan will help reduce maintenance burden</strong> by allowing a git repository to define your whole network</strong> of computers.</p>
<p>In combination with <a href="https://github.com/Mic92/sops-nix">sops-nix</a>, <a href="https://github.com/nix-community/nixos-anywhere">nixos-anywhere</a> and <a href="https://github.com/nix-community/disko">disko</a>, Clan makes it possible to have collaborative infrastructure</strong>.</p> <p>In combination with <a href="https://github.com/Mic92/sops-nix">sops-nix</a>, <a href="https://github.com/nix-community/nixos-anywhere">nixos-anywhere</a> and <a href="https://github.com/nix-community/disko">disko</a>, Clan makes it possible to have collaborative infrastructure</strong>.</p>
<p>At the heart of Clan are <a href="/services/official/">Clan Services</a> - the core concept that enables you to add functionality across multiple machines in your network. While Clan ships with essential core services, everyone can <a href="/guides/services/community/">create custom services</a> tailored to your specific needs.</p> <p>At the heart of Clan are <a href="/services/definition">Clan Services</a> - the core concept that enables you to add functionality across multiple machines in your network. While Clan ships with essential core services, everyone can <a href="/guides/services/community/">create custom services</a> tailored to your specific needs.</p>
</div> </div>
<label class="clamp-more" for="clan-readmore"></label> <label class="clamp-more" for="clan-readmore"></label>
</div> </div>

6
docs/site/reference/index.md
View File

@@ -5,9 +5,9 @@ This section of the site provides an overview of available options and commands
--- ---
- [Clan Configuration Option](/options) - for defining a Clan - [Clan Configuration Option](/options) - for defining a Clan
- Learn how to use the [Clan CLI](/reference/cli/index.md) - Learn how to use the [Clan CLI](../reference/cli/index.md)
- Explore available [services](/services/index.md) - Explore available [services](../services/definition.md)
- [NixOS Configuration Options](/reference/clan.core/index.md) - Additional options avilable on a NixOS machine. - [NixOS Configuration Options](../reference/clan.core/index.md) - Additional options avilable on a NixOS machine.
--- ---

2
lib/modules/inventoryClass/inventory.nix
View File

@@ -84,7 +84,7 @@ in
- The module MUST have at least `features = [ "inventory" ]` in the frontmatter section. - The module MUST have at least `features = [ "inventory" ]` in the frontmatter section.
- The module MUST have a subfolder `roles` with at least one `{roleName}.nix` file. - The module MUST have a subfolder `roles` with at least one `{roleName}.nix` file.
For further information see: [Module Authoring Guide](/guides/services/community.md). For further information see: [Module Authoring Guide](../../guides/services/community.md).
???+ example ???+ example
```nix ```nix

4
pkgs/clan-cli/clan_cli/hyperlink.py
View File

@@ -32,7 +32,9 @@ def help_hyperlink(description: str, url: str) -> str:
def docs_hyperlink(description: str, url: str) -> str: def docs_hyperlink(description: str, url: str) -> str:
"""Returns a markdown hyperlink""" """Returns a markdown hyperlink"""
url = url.replace("https://docs.clan.lol", "/") # Attention: this code assumes the URL maps directly to the filetree structure of the docs
# We should probably enforce this
url = url.replace("https://docs.clan.lol", "../..")
url = url.replace("index.html", "index") url = url.replace("index.html", "index")
url += ".md" url += ".md"
return f"[{description}]({url})" return f"[{description}]({url})"