Jump to content

Template talk:Nixos:package: Difference between revisions

From NixOS Wiki
Latest comment: 8 June by Pigs in topic Deletion candidate
DoggoBit (talk | contribs)
No edit summary
Pigs (talk | contribs)
Line 15: Line 15:
:For the second point, I think we should definitely be improving the main page itself to point the user to the search functionality as an option, as well as improving [[NixOS search]]. And on top of that, we probably want a [[First steps using NixOS]] page or similar to really drive this point home.
:For the second point, I think we should definitely be improving the main page itself to point the user to the search functionality as an option, as well as improving [[NixOS search]]. And on top of that, we probably want a [[First steps using NixOS]] page or similar to really drive this point home.
:For the third point, I don't think a package's current usage is an argument for or against its deletion (other than on technicality: we'd of course want to modify all pages using this template to point to the new one). However, do note, it's only used in [[Special:WhatLinksHere/Template:Nixos:package|24 pages]], hardly an edit burden. [[User:DoggoBit|DoggoBit]] ([[User talk:DoggoBit|talk]]) 17:10, 8 June 2025 (UTC)
:For the third point, I don't think a package's current usage is an argument for or against its deletion (other than on technicality: we'd of course want to modify all pages using this template to point to the new one). However, do note, it's only used in [[Special:WhatLinksHere/Template:Nixos:package|24 pages]], hardly an edit burden. [[User:DoggoBit|DoggoBit]] ([[User talk:DoggoBit|talk]]) 17:10, 8 June 2025 (UTC)
::When I was writing my reply I kept mistakenly was thinking of the {{:nixos:option}} template which is much more of a useful and popular template. My mistake.
::You are right that currently linking to a package on search.nixos.org does not provide as much information as it should. (It's more on the package maintainers to provide useful descriptions (like the {{nixos:package|docker}} maintainers do) than it is of a missing feature from search.nixos.org.
::I still hold my position that linking to {{nixos:package|ghc}} is a way better user experience than linking to {{Nixpkgs Link|pkgs/development/compilers/ghc/common-hadrian.nix}} both in terms of a maintainer and as an end user.
::To me, linking to source code is a bad option when there is a friendly interface that displays all the relevant information such as '''programs provided''', '''current version''', '''outputs''', and if a user wants to, there is a link to the source code on the search result. How fast can you find that information on the Nixpkgs link? The version isn't even mentioned in the source code of the main file for GHC. [[User:Pigs|Pigs]] ([[User talk:Pigs|talk]]) 21:31, 8 June 2025 (UTC)

Revision as of 21:31, 8 June 2025

Deletion candidate

Completely disagree about deleting this template.

  • Template:Nixpkgs links to the github page. That is not user friendly. Someone should not have to read source code files to understand module package options and descriptions. The UI on search.nixos.org is much more user friendly.
  • It is not LMGTFY as packages are not always indexed on search engines. It took me a long time as a NixOS user to learn about the existence of search.nixos.org, it should not be assumed that everyone is familiar with this service.
  • This is one of the most used templates on the wiki.

If anything, in my opinion we should be encouraging {{{1}}} over the use of Template:Nixpkgs unless if there is a specific reason that a user would find the source code important. Pigs (talk) 05:31, 8 June 2025 (UTC)Reply

I would agree with you if the core of the argument was implemented properly on the search page. I am 100% on the same page that we should aim for readability and user friendliness here. But that's exactly why I don't think this template hits the mark on that front.

Someone should not have to read source code files to understand module package options and descriptions.

That's exactly the thing: the search functionality doesn't expose package options at all. The only way an user can learn about them is by reading the source code. Is that ideal? Of course not, but it is currently what it is.
As for the description part, I would say in 99% of the time when this template is used, it's used either in the corresponding package's article, or in a context where adding the package description is trivial.
For the second point, I think we should definitely be improving the main page itself to point the user to the search functionality as an option, as well as improving NixOS search. And on top of that, we probably want a First steps using NixOS page or similar to really drive this point home.
For the third point, I don't think a package's current usage is an argument for or against its deletion (other than on technicality: we'd of course want to modify all pages using this template to point to the new one). However, do note, it's only used in 24 pages, hardly an edit burden. DoggoBit (talk) 17:10, 8 June 2025 (UTC)Reply
When I was writing my reply I kept mistakenly was thinking of the Nixos:option template which is much more of a useful and popular template. My mistake.
You are right that currently linking to a package on search.nixos.org does not provide as much information as it should. (It's more on the package maintainers to provide useful descriptions (like the docker maintainers do) than it is of a missing feature from search.nixos.org.
I still hold my position that linking to ghc is a way better user experience than linking to
⤟︎
This template is a candidate for merging with Template:Nixpkg. They seem to be duplicates. Further information may be found in the relevant discussion page.

pkgs/development/compilers/ghc/common-hadrian.nix both in terms of a maintainer and as an end user.

To me, linking to source code is a bad option when there is a friendly interface that displays all the relevant information such as programs provided, current version, outputs, and if a user wants to, there is a link to the source code on the search result. How fast can you find that information on the Nixpkgs link? The version isn't even mentioned in the source code of the main file for GHC. Pigs (talk) 21:31, 8 June 2025 (UTC)Reply