NixOS / nix

Nix, the purely functional package manager
https://nixos.org/
GNU Lesser General Public License v2.1
12.77k stars 1.52k forks source link

Reorganise the Package Management chapter #7769

Open fricklerhandwerk opened 1 year ago

fricklerhandwerk commented 1 year ago

Problem

The Package Management chapter is a mix of explanations, tutorials, and guides, most of which refer to nix-env, which is well-known to behave surprisingly. Since this is the first thing encountered by many users looking for instructions on how to use Nix (rightly so, since this is authoritative documentation), beginners are thrown for a long loop of not following best practices and end up with having to re-do lots of work or giving up in frustration.

Additionally, we agreed to move towards a structure of documentation following the Diátaxis framework, and that this manual should be a reference, which is reflected in its title.

Related:

Proposal

Remove the entire Package Management chapter from the manual.

The parts on garbage collection and channels are documented well enough in the respective command pages and can be removed, too. The parts on serving the Nix store could either be moved to a dedicated cookbook such as nix.dev or accommodated as examples for the substituters setting in nix.conf documentation.

This needs a bit of care not to lose vital information for beginners, and may be carried out in multiple steps.

TODO

Checklist

Priorities

Add :+1: to issues you find important.

nixos-discourse commented 1 year ago

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/tweag-nix-dev-update-45/26397/1

nixos-discourse commented 1 year ago

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-03-31-nix-team-meeting-minutes-45/27002/1

fricklerhandwerk commented 1 year ago

Discussed in the Nix team meeting 2023-04-03:

nixos-discourse commented 1 year ago

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-04-03-nix-team-meeting-minutes-46/27008/1

nixos-discourse commented 1 year ago

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-04-06-documentation-team-meeting-notes-39/27048/1

nixos-discourse commented 1 year ago

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-06-01-documentation-team-meeting-notes-51/28635/1

nixos-discourse commented 1 year ago

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/how-to-upgrade-packages/6151/16