NixOS / NixOS/nix.dev

Move nix-serve guide from Nix manual to nix.dev

Open
#460 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Move the contents of Serving a Nix store via HTTP to a stand-alone guide on nix.dev.

Up-to-date documentation on nix-serve: https://github.com/edolstra/nix-serve

Important
add a redirect on nixos.org, otherwise existing links will break

Context

This is to be able to implement https://github.com/NixOS/nix/issues/7769 without loss.

It's not clear how important this use case is, but for the sake of completeness we should find a new home for this guide and later decide if it's still supposed to be a supported use case.

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 existing guide in doc/manual/src/package-management/binary-cache-substituter.md and compare it with the current nix-serve documentation linked in the issue. Identify the appropriate stand-alone guide location on nix.dev, then update nixos-homepage/netlify.toml with a redirect. Done means the guide is available on nix.dev and existing links continue to resolve.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.