NixOS / NixOS/nix.dev

Document Nix installation in one place

Open
#424 4 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Problem description

Currently there are five (!) sources of truth for installing Nix:

  1. Nix manual (quickstart) (source)
  2. Nix manual (install) (source)
  3. Nix manual (binary installation) (source)
  4. nixos.org (source)
  5. nix.dev (source)

This creates additional maintenance overhead and leads to inconsistencies.

Proposal

Define one place where to maintain that information and either link to or reproduce it in the other locations.

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

Compare the five installation sources listed in the issue, starting with their linked source files: the Nix manual quickstart and installation pages, nixos.org/download.html, and nix.dev/source/tutorials/install-nix.md. Decide where the installation information should be maintained, then link to or reproduce it consistently in the other locations; done means there is one maintained source without conflicting instructions.

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
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.