NixOS/nix

Move the Tuning Cores section to nix.conf

Open

#7,980 opened on Mar 5, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (1,293 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (9,803 stars)
PR merge metrics
 (Avg merge 7d 11h) (83 merged PRs in 30d)

Description

Problem

The contents of Tuning Cores is regular reference documentation that is hard to find outside where one would expect the parameter documentation.

Proposal

Move the information to the documentation of cores and link to it from max-jobs; 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

Research direction
Locate the current Tuning Cores page in the Nix manual source. Move its content to the documentation of 'cores' in nix.conf, and add a cross reference from 'max jobs'. Also add a redirect rule in netlify.toml for the old URL.
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.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80