NixOS / NixOS/nix.dev

Bootable ISO tutorial outdated?

Open
#1,233 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

site
Dominant language
Nix
Stars
4k
Forks
339
Avg merge
2d 11h
Merged PRs (30d)
7

Description

Observations

The section for bootable ISOs describes the process using nixos-generators, which has been archived earlier this year after being upstreamed into nixpkgs.

Problem

nix.dev was the top search result for me, but since I had never used NIX_PATH before it seemed unfamiliar (new-ish user alert). I then went to cross-reference with the NixOS Manual and the NixOS Wiki, which both describe a different process. I find the Wiki article to be the most comprehensive since it shows both the flake and non-flake approach.

So my question boils down to two things:

  1. Is it intended that nix.dev shows a different (older?) process for the sake of completeness?
  2. Should the newer flake/non-flake approaches be added?

Approaches

  1. Leave it as-is -> occasionally get confused users like me.
  2. Converge/update the three named resources -> if so, in which way should the three resources differ from each other, in order for each to serve their specific purpose/audience?

Willing to help?

Yes. I intended to open a PR, but decided that I don't know enough to propose a solution.

Priorities

Add 👍 to issues you find important.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the nix.dev bootable ISO tutorial and compare its nixos-generators instructions with the NixOS Manual and Wiki pages linked in the issue. Confirm the current upstreamed workflow and decide whether the tutorial should update or explain both flake and non-flake approaches; done means the nix.dev guidance is current and its relationship to the other resources is clear.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.