Skip to content

Commit 759091c

Browse files
sedlundmergify[bot]
sedlund
authored and
mergify[bot]
committed
docs: cleanup
fixup
1 parent 9584f86 commit 759091c

File tree

10 files changed

+218
-195
lines changed

10 files changed

+218
-195
lines changed

‎README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ data has been migrated.
8181
- The machine must be reachable over the public internet or local network.
8282
Nixos-anywhere does not support wifi networks. If a VPN is needed, define a
8383
custom installer via the --kexec flag which connects to your VPN.
84-
- (when `kexec` is used) must have at least 1 GB of RAM, excluding swap.
84+
- When `kexec` is used the target must have at least 1 GB of RAM, excluding
85+
swap.
8586

8687
## How to use nixos-anywhere
8788

@@ -103,7 +104,7 @@ For questions, come join us in the
103104
## Licensing and Contribution details
104105

105106
This software is provided free under the
106-
[MIT Licence](https://opensource.org/licenses/MIT).
107+
[MIT License](https://opensource.org/licenses/MIT).
107108

108109
---
109110

‎docs/howtos/nix-path.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ configuration instead:
3737
}
3838
```
3939

40-
Advantage: This solution will be automatically kept up-to-date everytime the
40+
Advantage: This solution will be automatically kept up-to-date every time the
4141
flake is updated.
4242

4343
In your shell you will see something in your `$NIX_PATH`:

‎docs/quickstart.md

Lines changed: 204 additions & 182 deletions
Large diffs are not rendered by default.

‎docs/reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ the relevant operating system manual.
8181
| Id | Message | Explanation |
8282
| -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
8383
| 1 | Failure unpacking initrd | You don't have enough RAM to hold `kexec` |
84-
| 2 | Flake <flake_url> does not provide attirbute | The configuration name you specified in your flake URI is not defined as a NixOS configuration in your flake eg if your URI was mydir#myconfig, then myconfig should be included in the flake as `nixosConfigurations.myconfig` |
84+
| 2 | Flake <flake_url> does not provide attribute | The configuration name you specified in your flake URI is not defined as a NixOS configuration in your flake eg if your URI was mydir#myconfig, then myconfig should be included in the flake as `nixosConfigurations.myconfig` |
8585
| 3 | Please specify the name of the NixOS configuration to be installed, as a URI fragment in the flake-uri. | As for error #2 |
8686
| | For example, to use the output nixosConfigurations.foo from the flake.nix, append "#foo" to the flake-uri | |
8787
| 4 | Retrieving host facts via ssh failed. Check with --debug for the root cause, unless you have done so already | TODO: Explain |

‎docs/requirements.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## Requirements
1010

11-
### Source Machine:
11+
### Source Machine
1212

1313
1. **Supported Systems:**
1414
- Linux or macOS computers with Nix installed.
@@ -21,7 +21,7 @@
2121
2. **Nix Installation:** If Nix is not yet installed on your system, refer to
2222
the [nix installation page](https://nixos.org/download#download-nix).
2323

24-
### Destination Machine:
24+
### Destination Machine
2525

2626
The machine must be reachable over the public internet or local network.
2727
Nixos-anywhere does not support wifi networks. If a VPN is needed, define a

‎terraform/all-in-one.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ No resources.
110110
| <a name="input_debug_logging"></a> [debug\_logging](#input_debug_logging) | Enable debug logging | `bool` | `false` | no |
111111
| <a name="input_deployment_ssh_key"></a> [deployment\_ssh\_key](#input_deployment_ssh_key) | Content of private key used to deploy to the target\_host after initial installation. To ensure maximum security, it is advisable to connect to your host using ssh-agent instead of relying on this variable | `string` | `null` | no |
112112
| <a name="input_disk_encryption_key_scripts"></a> [disk\_encryption\_key\_scripts](#input_disk_encryption_key_scripts) | Each of these script files will be executed locally and the output of each of them will be made present at the given path to disko during installation. The keys will be not copied to the final system | <pre>list(object({<br> path = string<br> script = string<br> }))</pre> | `[]` | no |
113-
| <a name="input_extra_environment"></a> [extra\_environment](#input_extra_environment) | Extra environment variables to be set during installation. This can be usefull to set extra variables for the extra\_files\_script or disk\_encryption\_key\_scripts | `map(string)` | `{}` | no |
113+
| <a name="input_extra_environment"></a> [extra\_environment](#input_extra_environment) | Extra environment variables to be set during installation. This can be useful to set extra variables for the extra\_files\_script or disk\_encryption\_key\_scripts | `map(string)` | `{}` | no |
114114
| <a name="input_extra_files_script"></a> [extra\_files\_script](#input_extra_files_script) | A script file that prepares extra files to be copied to the target host during installation. The script expected to write all its files to the current directory. This directory is copied to the target host during installation to the / directory. | `string` | `null` | no |
115115
| <a name="input_file"></a> [file](#input_file) | Nix file containing the nixos\_system\_attr and nixos\_partitioner\_attr. Use this if you are not using flake | `string` | `null` | no |
116116
| <a name="input_install_ssh_key"></a> [install\_ssh\_key](#input_install_ssh_key) | Content of private key used to connect to the target\_host during initial installation | `string` | `null` | no |

‎terraform/all-in-one/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ variable "disk_encryption_key_scripts" {
9292

9393
variable "extra_environment" {
9494
type = map(string)
95-
description = "Extra environment variables to be set during installation. This can be usefull to set extra variables for the extra_files_script or disk_encryption_key_scripts"
95+
description = "Extra environment variables to be set during installation. This can be useful to set extra variables for the extra_files_script or disk_encryption_key_scripts"
9696
default = {}
9797
}
9898

‎terraform/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ No modules.
6666
| <a name="input_build_on_remote"></a> [build\_on\_remote](#input_build_on_remote) | Build the closure on the remote machine instead of building it locally and copying it over | `bool` | `false` | no |
6767
| <a name="input_debug_logging"></a> [debug\_logging](#input_debug_logging) | Enable debug logging | `bool` | `false` | no |
6868
| <a name="input_disk_encryption_key_scripts"></a> [disk\_encryption\_key\_scripts](#input_disk_encryption_key_scripts) | Each of these script files will be executed locally and the output of each of them will be made present at the given path to disko during installation. The keys will be not copied to the final system | <pre>list(object({<br> path = string<br> script = string<br> }))</pre> | `[]` | no |
69-
| <a name="input_extra_environment"></a> [extra\_environment](#input_extra_environment) | Extra environment variables to be set during installation. This can be usefull to set extra variables for the extra\_files\_script or disk\_encryption\_key\_scripts | `map(string)` | `{}` | no |
69+
| <a name="input_extra_environment"></a> [extra\_environment](#input_extra_environment) | Extra environment variables to be set during installation. This can be useful to set extra variables for the extra\_files\_script or disk\_encryption\_key\_scripts | `map(string)` | `{}` | no |
7070
| <a name="input_extra_files_script"></a> [extra\_files\_script](#input_extra_files_script) | A script file that prepares extra files to be copied to the target host during installation. The script expected to write all its files to the current directory. This directory is copied to the target host during installation to the / directory. | `string` | `null` | no |
7171
| <a name="input_flake"></a> [flake](#input_flake) | The flake to install the system from | `string` | `""` | no |
7272
| <a name="input_instance_id"></a> [instance\_id](#input_instance_id) | The instance id of the target\_host, used to track when to reinstall the machine | `string` | `null` | no |

‎terraform/install/variables.tf

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ variable "stop_after_disko" {
6161

6262
variable "extra_files_script" {
6363
type = string
64-
description = "A script file that prepares extra files to be copied to the target host during installation. The script expected to write all its files to the current directory. This directory is copied to the target host during installation to the / directory."
64+
description = "A script that should place files in the current directory that will be copied to the targets / directory"
6565
default = null
6666
}
6767

@@ -70,13 +70,13 @@ variable "disk_encryption_key_scripts" {
7070
path = string
7171
script = string
7272
}))
73-
description = "Each of these script files will be executed locally and the output of each of them will be made present at the given path to disko during installation. The keys will be not copied to the final system"
73+
description = "Each script will be executed locally. Output of each will be created at the given path to disko during installation. The keys will be not copied to the final system"
7474
default = []
7575
}
7676

7777
variable "extra_environment" {
7878
type = map(string)
79-
description = "Extra environment variables to be set during installation. This can be usefull to set extra variables for the extra_files_script or disk_encryption_key_scripts"
79+
description = "Extra environment variables to be set during installation. This can be useful to set extra variables for the extra_files_script or disk_encryption_key_scripts"
8080
default = {}
8181
}
8282

‎terraform/nixos-rebuild/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ variable "target_port" {
2222

2323
variable "ssh_private_key" {
2424
type = string
25-
description = "Content of private key used to connect to the target_host. If set to - no key is passed to openssh and ssh will back to its own configuration"
25+
description = "Content of private key used to connect to the target_host. If set to - no key is passed to openssh and ssh will use its own configuration"
2626
default = "-"
2727
}
2828

0 commit comments

Comments
 (0)