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

docs: fix typos

Browse Source
This commit is contained in:
Michael Hoang
2024-12-10 18:46:40 +11:00
parent d28f6a24e9
commit eb13e7a40c
4 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -94,7 +94,7 @@ After writing the installer to the USB drive, use it to boot the target machine.
5. Select `NixOS` to boot into the clan installer 5. Select `NixOS` to boot into the clan installer
6. The installer will display an IP address and a root password, which you can use to connect via SSH. 6. The installer will display an IP address and a root password, which you can use to connect via SSH.
Alternatively you can also use the displayed QR code. Alternatively you can also use the displayed QR code.
7. Set your keyboard language (i.e. `de` for German keyboards, default is English). Important for writing passwords correctly. 7. Set your keyboard language (i.e. `de` for German keyboards, default is English). Important for writing passwords correctly.
@@ -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
--- ---

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

@@ -4,7 +4,7 @@ Our installer image simplifies the process of performing remote installations.
Follow our step-by-step guide to create and transfer this image onto a bootable USB drive. Follow our step-by-step guide to create and transfer this image onto a bootable USB drive.
!!! info !!! info
If you already have a NixOS machine you can ssh into (in the cloud for example) you can skip this chapter and go directly to [Configure Machines](configure.md). If you already have a NixOS machine you can ssh into (in the cloud for example) you can skip this chapter and go directly to [Configure Machines](configure.md).
### Step 0. Prerequisites ### Step 0. Prerequisites
@@ -54,7 +54,7 @@ sudo umount /dev/sdb1
flash-installer flash-installer
``` ```
!!! Note !!! Note
Replace `$HOME/.ssh/id_ed25519.pub` with a path to your SSH public key. Replace `$HOME/.ssh/id_ed25519.pub` with a path to your SSH public key.
Replace `/dev/sd<X>` with the drive path you want to flash Replace `/dev/sd<X>` with the drive path you want to flash
!!! Danger "Specifying the wrong device can lead to unrecoverable data loss." !!! Danger "Specifying the wrong device can lead to unrecoverable data loss."
@@ -73,13 +73,13 @@ sudo umount /dev/sdb1
``` ```
clan flash list keymaps clan flash list keymaps
``` ```
- **List Languages**: - **List Languages**:
You can get a list of all languages with the following command: You can get a list of all languages with the following command:
``` ```
clan flash list languages clan flash list languages
``` ```
@@ -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