search

nix-community / wiki

Nixos wiki [maintainer=@samueldr]
http://wiki.nixos.org/
MIT License
102 stars 7 forks source link

Too many different articles on packaging #22

Closed Mic92 closed 6 years ago

Mic92 commented 6 years ago

These articles explain in one way or the other to create nix packages:

makefu commented 6 years ago

I'd suggest that we create a top-level directory on packaging software as this is pretty much the main topic where people have questions. This could be used as entry point to all the subsection and quirks of packaging.

there is also:

samueldr commented 6 years ago

I concur with @makefu, making a main article about packaging, which will link to more in-depth knowledge. Otherwise the page is too long.

My opinion on that is that longer pages suck, especially when they are written in a way that present many subjects. It makes scrolling through the page harder, but especially, it makes linking hard. Anchors in mediawiki are built upon the text of the title, breaking links when titles are re-worded.

Though, this shouldn't stop any pages being long, as long as it's about one subject.

nyarly commented 6 years ago

As I've been learning Nix, this has been a daunting task only because it seems initially so impenetrable. There's so many ways to package software in Nix, and from the outset it's hard to approach.

In my experience, the Nixpkgs manual quickstart is actually really good, and a good reference for how to package a piece of software. I seem glimmers of essential advice in the above pages, but my vote would be to fold that advice into the manual and edit the wiki to direct readers there.

makefu commented 6 years ago

I suggest we could add a namespace for Packaging software and add an overview article which lists all the different ways and why/when you would need them.

The overview article could make an initial hint towards the nixpkgs quickstart and afterwards list the resources in the wiki

samueldr commented 6 years ago

As a technical detail, namespaces (words followed by colon as in Workgroup: and Help:) will not show up in the wiki search results by default. This is why for some sections (e.g.: NixOS_on_ARM) I have started to use sub-pages (e.g.: NixOS_on_ARM/Raspberry_Pi). This way, they are treated exactly like the other pages with regards to indexing and probably some other technical details like categories.

Otherwise, yes, something like Packaging/* for the sub-pages, I really like.

makefu commented 6 years ago

sounds good to me 👍

makefu commented 6 years ago

Closed by adding two new namespaces Nixpkgs and packaging. The nixpkgs namespace contains articles especially about working with nixpkgs, packaging contains generic information on how to build and package stuff.