108 lines
2.0 KiB
Markdown
108 lines
2.0 KiB
Markdown
---
|
|
hide:
|
|
- navigation
|
|
- toc
|
|
---
|
|
|
|
# :material-home: Welcome to **Clan**'s documentation
|
|
|
|
[Getting Started](./getting-started/index.md){ .md-button }
|
|
|
|
## Tutorials
|
|
|
|
**Learning-oriented adventures with a hands-on experience.**
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- :material-clock-fast:{ .lg .middle } __Set up in 15 minutes__
|
|
|
|
---
|
|
|
|
Create your own clan and get everything
|
|
running in minutes
|
|
|
|
[:octicons-arrow-right-24: Getting started](./getting-started/index.md)
|
|
|
|
- :fontawesome-solid-user-group:{ .lg .middle } __Authoring Modules__
|
|
|
|
---
|
|
|
|
Create ressources that can be reused by the community.
|
|
|
|
[:octicons-arrow-right-24: Authoring guides](./authoring/legacyModules/index.md)
|
|
|
|
</div>
|
|
|
|
## :material-book: Guides
|
|
|
|
**How-to Guides for achieving a certain goal or solving a specific issue.**
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- [Autoincludes](./manual/adding-machines.md)
|
|
|
|
---
|
|
|
|
Learn how Clan automatically includes machines and Nix files.
|
|
|
|
- [Vars Backend](./manual/vars-backend.md)
|
|
|
|
---
|
|
|
|
Learn how to manage secrets with facts.
|
|
|
|
- [Inventory](./manual/inventory.md)
|
|
|
|
---
|
|
|
|
Clan's declaration format for running **services** on one or multiple **machines**.
|
|
|
|
- [Flake-parts](./manual/flake-parts.md)
|
|
|
|
---
|
|
|
|
Use clan with [https://flake.parts/]()
|
|
|
|
- [Contribute](./contributing/contribute.md)
|
|
|
|
---
|
|
|
|
Discover how to set up a development environment to contribute to Clan!
|
|
|
|
</div>
|
|
|
|
## API Reference
|
|
|
|
**Reference API Documentation**
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- [Reference Overview](./reference/index.md)
|
|
|
|
---
|
|
|
|
Learn how to interface with Clan programmatically
|
|
|
|
- [Cli Reference](./reference/cli/index.md)
|
|
|
|
---
|
|
|
|
The `clan` cli command
|
|
|
|
- [Modules](./reference/clanModules/index.md)
|
|
|
|
---
|
|
|
|
An overview of available clan modules
|
|
|
|
- [Core](./reference/clan-core/index.md)
|
|
|
|
---
|
|
|
|
The clan core nix module.
|
|
This is imported when using clan and is the basis of the extra functionality
|
|
that can be provided.
|
|
|
|
|
|
</div>
|