From 1badc1d1639d95d11a20aded68cfeb09bb83cb69 Mon Sep 17 00:00:00 2001 From: Liam McDermott Date: Thu, 18 Apr 2024 16:16:05 -0400 Subject: [PATCH 1/2] Rewrite 'Enabling Flakes' section of Installation docs. - Provide clarity on whether to install Flakes (recommend users enable the feature). - Add link to beginners' guide to NixOS & Flakes. - Rewrite awkward wording and grammar, like '[...] all the Nix stuff is being handled for you.' - Provide the user with context on Flakes and why they need to be enabled, without overwhelming them. --- Guide/installation.markdown | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/Guide/installation.markdown b/Guide/installation.markdown index 6cca20358..4e1a73cb0 100644 --- a/Guide/installation.markdown +++ b/Guide/installation.markdown @@ -114,18 +114,22 @@ Installing nix for IHP was done using [this guide](https://nathan.gs/2019/04/12/ Note that nix can gradually grow to use several GB of disk space, especially after upgrading IHP. You can always run `nix-collect-garbage` in a `nix-shell` which will delete older/unused files. -### Enabling flakes +### Optional: Enabling Flakes -IHP uses Nix flakes. While already widely used, they are still a quite new feature and not yet enabled by default by the Nix install scripts. +Flakes is an experimental part of Nix, so the installation steps above would not have enabled this useful feature. -If you use IHP normally and with direnv this won't be a problem for you because all the Nix stuff is being handled for you. However, it's a good idea to enable flakes, so you can benefit from their features if you need them or want to try them out. +IHP uses Flakes, but only internally and without affecting the rest of your Nix environment. Enabling it is optional, but we believe it's a great feature; well worth learning and using in your projects! -To enable flakes, either edit `~/.config/nix/nix.conf` (to enable just for your user) or `/etc/nix/nix.conf` (to enable flakes globally) and add the following line: +To enable Flakes for your Nix installation, add the following line to `~/.config/nix/nix.conf` (or `/etc/nix/nix.conf` to enable flakes for every user on your machine): ```bash experimental-features = nix-command flakes ``` +If you are unsure whether to enable Flakes or not, we recommend enabling it. + +This [NixOS & Flakes Book](https://nixos-and-flakes.thiscute.world/) provides a guide for beginners. + ## 2. Installing IHP You can now install IHP by running: From fdad40caa9bc74010ea8fe137433220f3e1a9b9e Mon Sep 17 00:00:00 2001 From: Liam McDermott Date: Thu, 18 Apr 2024 16:27:58 -0400 Subject: [PATCH 2/2] Further changes to 'Enabling Flakes' section. --- Guide/installation.markdown | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/Guide/installation.markdown b/Guide/installation.markdown index 4e1a73cb0..74105db87 100644 --- a/Guide/installation.markdown +++ b/Guide/installation.markdown @@ -118,17 +118,15 @@ Note that nix can gradually grow to use several GB of disk space, especially aft Flakes is an experimental part of Nix, so the installation steps above would not have enabled this useful feature. -IHP uses Flakes, but only internally and without affecting the rest of your Nix environment. Enabling it is optional, but we believe it's a great feature; well worth learning and using in your projects! +IHP uses Flakes, but only internally and without affecting the rest of your Nix environment. Enabling it for your whole Nix environment is optional, but we believe it's a great feature that's well worth learning and using in your projects! -To enable Flakes for your Nix installation, add the following line to `~/.config/nix/nix.conf` (or `/etc/nix/nix.conf` to enable flakes for every user on your machine): +To enable Flakes, add the following line to `~/.config/nix/nix.conf` (or `/etc/nix/nix.conf` to enable flakes for every user on your machine): ```bash experimental-features = nix-command flakes ``` -If you are unsure whether to enable Flakes or not, we recommend enabling it. - -This [NixOS & Flakes Book](https://nixos-and-flakes.thiscute.world/) provides a guide for beginners. +If you are unsure, we recommend enabling Flakes. For a beginner's guide, see this [NixOS & Flakes Book](https://nixos-and-flakes.thiscute.world/). ## 2. Installing IHP