NixOS/nix

Move the Tuning Cores section to nix.conf

Open

#7980 opened on Mar 5, 2023

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

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

Tech stack
cpp
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of Nix documentationfamiliarity with nix.conf format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the current 'Tuning Cores' page located at advanced topics/cores vs jobs in the Nix manual. Review the documentation for the 'cores' and 'max jobs' options in nix.conf to understand where to integrate the information. Also check the nixos homepage repository's netlify.toml file for the redirect rule pattern. The issue provides a clear proposal: move the content, add a cross link, and remove the old page.