NixOS/nix

Find a place for reference documentation in Serving a Nix store via SSH

Open

#7,978 opened on Mar 5, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (9,803 stars) (1,293 forks)batch import
documentationgood first issue

Description

Problem

Serving a Nix store via SSH is a how-to guide that should be removed from the reference manual, see #7769.

Proposal

It's not entirely clear where the still interesting reference-style information and examples that don't appear anywhere else should go instead. There currently seems to be no place where the different URL syntaxes for substituters are documented.

Options:

Move the information, remove the page.

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

Priorities

Add :+1: to issues you find important.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Nix documentation structureMarkdownNetlify redirects
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the linked issue #7769 for context. Examine the documentation pages for nix copy closure and substituters to determine where the reference information fits best. Then move the content from the SSH substituter page to the chosen location, remove the original page, and add a redirect in the Netlify configuration file (netlify.toml) in the NixOS homepage repository.