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

Merge pull request 'docs: small fixes' (#2590) from Enzime/clan-core:push-ntnmoqslpuot into main

Browse Source
This commit is contained in:
clan-bot
2024-12-11 03:42:04 +00:00
parent cd5725ef25 38d867a4e1
commit cd2a4210ac
6 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/mkdocs.yml
View File

@@ -180,7 +180,7 @@ extra_css:
extra: extra:
social: social:
- icon: fontawesome/regular/comment - icon: fontawesome/regular/comment
link: https://matrix.to/#/#clan:lassul.us link: https://matrix.to/#/#clan:clan.lol
- icon: fontawesome/brands/gitlab - icon: fontawesome/brands/gitlab
link: https://git.clan.lol/clan/clan-core link: https://git.clan.lol/clan/clan-core
- icon: fontawesome/brands/github - icon: fontawesome/brands/github

2
docs/site/drafts/install-iso.md
View File

@@ -139,7 +139,7 @@ After writing the installer to the USB drive, use it to boot the target machine.
--- ---
# Whats next? # What's next?
- Deploy a clan machine-configuration on your prepared machine - Deploy a clan machine-configuration on your prepared machine

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

@@ -202,7 +202,7 @@ For renaming jon to your own machine name, you can use the following command:
git mv ./machines/jon ./machines/newname git mv ./machines/jon ./machines/newname
``` ```
If you only want to setup a single machine at this point, you can delete `sara` from flake.nix as well as from the machines directory: If you only want to setup a single machine at this point, you can delete `sara` from `flake.nix` as well as from the machines directory:
``` ```
git rm ./machines/sara git rm ./machines/sara
@@ -210,8 +210,8 @@ git rm ./machines/sara
--- ---
## Whats next? ## What's next?
- [Secrets & Facts](secrets.md): Setting up secrets with nix-sops - [Secrets & Facts](secrets.md): Setting up secrets with sops-nix
--- ---

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

@@ -183,7 +183,7 @@ You're all set up
--- ---
## Whats next? ## What's next?
- [Configure Machines](configure.md): Customize machine configuration - [Configure Machines](configure.md): Customize machine configuration

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

@@ -85,7 +85,7 @@ This command helps ensure that your system configuration is correct and free fro
You can integrate this step into your [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) workflow to ensure that only valid Nix configurations are merged into your codebase. You can integrate this step into your [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) workflow to ensure that only valid Nix configurations are merged into your codebase.
## Whats next? ## What's next?
- [Deployment](deploy.md): How to remotely deploy your machine - [Deployment](deploy.md): How to remotely deploy your machine
- Full [Secrets](../manual/secrets.md) guide If you want to know more about how to save and share passwords in your clan - Full [Secrets](../manual/secrets.md) guide If you want to know more about how to save and share passwords in your clan

18
docs/site/manual/adding-machines.md
View File

@@ -1,22 +1,22 @@
# Adding Machines # Adding Machines
Clan has two general methods of adding machines Clan has two general methods of adding machines:
- **Automatic**: Detects every folder in the `machines` folder. - **Automatic**: Detects every folder in the `machines` folder.
- **Declarative**: Explicit declarations in nix. - **Declarative**: Explicit declarations in Nix.
## Automatic register ## Automatic registration
Every machine of the form `machines/{machineName}` will be registered automatically. Every folder `machines/{machineName}` will be registered automatically as a Clan machine.
!!! info "Automatically loaded files" !!! info "Automatically loaded files"
Some files are loaded by a clan machine automatically. This decision was made for convinience and allows easier automation. The following files are loaded automatically for each Clan machine:
- [x] ``machines/{machineName}/configuration.nix` - [x] `machines/{machineName}/configuration.nix`
- [x] ``machines/{machineName}/hardware-configuration.nix` - [x] `machines/{machineName}/hardware-configuration.nix`
- [x] ``machines/{machineName}/facter.json` Automatically configured, for further information see [nixos-facter](https://clan.lol/blog/nixos-facter/) - [x] `machines/{machineName}/facter.json` Automatically configured, for further information see [nixos-facter](https://clan.lol/blog/nixos-facter/)
- [x] ``machines/{machineName}/disko.nix` Automatically loaded, for further information see the [disko docs](https://github.com/nix-community/disko/blob/master/docs/quickstart.md). - [x] `machines/{machineName}/disko.nix` Automatically loaded, for further information see the [disko docs](https://github.com/nix-community/disko/blob/master/docs/quickstart.md).
## Manual declaration ## Manual declaration