Skip to content

Instantly share code, notes, and snippets.

@FRidh
Last active October 27, 2020 17:18
Show Gist options
  • Save FRidh/0fbb86fde3c4e26045a1 to your computer and use it in GitHub Desktop.
Save FRidh/0fbb86fde3c4e26045a1 to your computer and use it in GitHub Desktop.

Nix guides

Currently the following guides exist:

  1. Nix reference guide
  2. NixOS reference guide
  3. Hydra reference guide
  4. Nixpkgs guide

as well as a (mostly outdated) read-only wiki.

What is missing is introductory material. There are also complaints that the current tooling used for the guides hinders contributing. Contributions to the guides are currently peer-reviewed, and we should maintain that to keep the quality high.

I propose we create the following guides:

  1. Nix reference guide
  2. NixOS reference guide
  3. Hydra reference guide
  4. Nix user guide -
  5. Nixpkgs contributor guide

The Nix guides

Nix reference guide

The Nix reference guide should provide an overview and technical details of the Nix package manager and language.

NixOS reference guide

The NixOS reference guide should provide an overview and technical details of NixOS (and thus also the concept of modules).

Hydra reference guide

The NixOS reference guide should provide an overview and technical details of the Hydra software, and not the service https://hydra.nixos.org.

Nix user guide

The Nix users guide will be the main guide for Nix users. The guide should provide introductory material as well as reference material.

  • Introduction to
    • Nix ecosystem
    • Nix package manager
    • Nixpkgs
      • Nixpkgs Hydra
    • NixOS
    • Hydra (NOT https://hydra.nixos.org.)
    • Python on Nix
    • Haskell on Nix
    • ...
  • Reference
    • Modules

    • Python
      • buildPythonPackage
    • Haskell

Nixpkgs contributor guide

The Nixpkgs contributor guide contains details about Nixpkgs style and how to contribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment