Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on enabling flakes is unclear #604

Open
zachauten opened this issue Dec 6, 2024 · 1 comment
Open

Documentation on enabling flakes is unclear #604

zachauten opened this issue Dec 6, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@zachauten
Copy link

Bug description

I'm a little unsure how to interpret the page of the documentation on how to enable flakes.

First add a nixos-wsl input, then add nixos-wsl.nixosModules.default to your nixos configuration

To me, this reads as instructions to add the following code block to the system configuration at /etc/nixos/configuration.nix, that I've been working in as I follow the previous steps in the docs. But the code snippet is also labelled with:

Below is a minimal flake.nix for you to get started:

Which makes me think it's supposed to go in a standalone file. Adding it to /etc/nixos/configuration.nix gave me a big fat error message, so I'm pretty sure I'm not supposed to do that.

I'm new to NixOS, but I've read some things online about flakes, and found them useful when I used the Nix package manager on macOS & Debian. But I also didn't see them mentioned much at all in the manual, and the Nix wiki says they're still experimental. I'm not sure if they're recommended on WSL, or how to best go about enabling them.

It might be a good idea to add some info to that page of the NixOS-WSL documentation to answer:

  1. Is enabling flakes reccomended?
  2. Links to relevant documentation on how to get started using flakes.
  3. More context around the relationship between the system configuration and the given flake.nix example.

Thanks!

To Reproduce

Steps to reproduce the behavior:

Logs

Include relevant console logs

WSL version

I'm using 2

Please paste the output of wsl --version here
@zachauten zachauten added the bug Something isn't working label Dec 6, 2024
@zachauten
Copy link
Author

I did find the solution in another guide, if updating the docs seems desirable I'd be glad to open a PR now that I understand the steps I was missing.

@SuperSandro2000 SuperSandro2000 added documentation Improvements or additions to documentation and removed bug Something isn't working labels Dec 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants