!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

415 Members
Discussion about documentation improvements around the Nix ecosystem84 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
17 Jul 2023
@domenkozar:matrix.orgDomen KožarThat's really orthogonal, most users use flakes, that's the interface they expect.17:12:53
@domenkozar:matrix.orgDomen KožarEither way, if we make changes it will be V2.17:13:07
@infinisil:matrix.orginfinisilI'd rather have well-designed software than many users. The better something is designed, the longer it will last because it's harder for something better to replace it17:16:39
@domenkozar:matrix.orgDomen KožarWhat I'm saying is that's not the reality we live in. We can talk about dreams, but there are a lot of Nix Flakes users that need documentation to be able to use it.17:17:07
@domenkozar:matrix.orgDomen KožarThere were many mistakes made on the path of flakes, but not having the docs is something we need to fix asap.17:18:04
@infinisil:matrix.orginfinisilYeah I get it, that's just not where my priorities are. There's more dire problems to solve than to document hacked-together experimentally-labeled features17:18:52
@infinisil:matrix.orginfinisil * Yeah I get it, that's just not where my priorities are. I think there's more dire problems to solve than to document hacked-together experimentally-labeled features17:19:30
@brian:bmcgee.ie@brian:bmcgee.ie I lean more Domen Kožar's direction on this one for the simple reason that the majority of my 2 years with Nix has been flake-oriented. The only time I write a shell.nix is to make a project compatible for non flake users. There are valid concerns about flakes and a need to stabilise them. Maybe I'm putting effort in the wrong place and should be helping to stabilise flakes like you said infinisil rather than putting effort into documenting a workflow I choose not to use on a daily basis (and I say this without any kind of snark or ill feeling). 18:13:02
@brian:bmcgee.ie@brian:bmcgee.ieBtw, I'll be at NixCon 🥳18:13:38
@infinisil:matrix.orginfinisilI guess I also really don't like how the documentation team is seemingly put into the responsibility to document Flakes.18:16:49
@infinisil:matrix.orginfinisilThe people adding a new feature should be responsible for documenting it and ensuring it's well-designed so it can be stabilised18:18:22
@infinisil:matrix.orginfinisilThis would also set a precedent that the docs team will document whatever ill-designed and barely-documented feature gets merged into Nix18:19:40
@brian:bmcgee.ie@brian:bmcgee.ieYeah that's a fair point. I wanted to know what the schema was for the json output when using `nix flake show` and had to look at the source ... no bueno18:19:47
@brian:bmcgee.ie@brian:bmcgee.ieIf you don't document something after you write it because it's experimental and subject to change then you can't really expect the docs team to do the same 18:21:33
@infinisil:matrix.orginfinisilAlso, the more general precedent of how RFCs can just be canceled, merged as experimental if you have the right commit bit, encouraged to be used by everybody if you have an audience, and then require teams to adapt to it18:21:37
@infinisil:matrix.orginfinisil Relevant is Alyssa Ross's comment here: https://github.com/NixOS/rfcs/pull/136#discussion_r987278726 18:22:22
@brian:bmcgee.ie@brian:bmcgee.ieI agree with the comment, if it's experimental, break it as necessary. As a flakes user I accept the churn, and I'll update as necessary. I know there will be a lot of people unhappy about any kind of breakage but I think this would be a valuable lesson as to why you don't let experimental features sit for long enough to become de facto use cases for a large chunk of people rather than stabilising them 18:26:31
@infinisil:matrix.orginfinisilYeah, that's gonna be really hard though, there's third-party products being built daily on top of experimental flakes without any care in the world (if only that kind of effort went into flakes stabilisation)18:27:48
@infinisil:matrix.orginfinisil I really like John Ericson's suggestions for what Nix should become here: https://github.com/NixOS/rfcs/pull/136#discussion_r1246035453 18:29:15
@Ericson2314:matrix.orgJohn Ericson:)18:29:50
@Ericson2314:matrix.orgJohn EricsonI get that flakes have driven a lot of new usage, but that is just because everything else was so unpolished18:30:11
@Ericson2314:matrix.orgJohn Ericsonthe bar was so low18:30:15
@Ericson2314:matrix.orgJohn Ericson Flakes are a "fast food" that kinda tastes good to start but ultimately fails to truly solve any problems 18:30:45
@Ericson2314:matrix.orgJohn EricsonWe have to believe the choices are not just "Flakes" or "unpolished unusuable to non-experts"18:31:32
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @infinisil:matrix.org
This would also set a precedent that the docs team will document whatever ill-designed and barely-documented feature gets merged into Nix
I agree with most of your other points, but this precedent has definitely already been set by stable nix+nixpkgs, at least the part about us having to ex post document barely-documented stuff
18:32:23
@infinisil:matrix.orginfinisilWe can't deny that Flakes does solve some problems. Though it also introduces a whole bunch of new problems along the way, problems which shouldn't be necessary18:32:36
@infinisil:matrix.orginfinisil
In reply to @asymmetric:matrix.dapp.org.uk
I agree with most of your other points, but this precedent has definitely already been set by stable nix+nixpkgs, at least the part about us having to ex post document barely-documented stuff
Hehe fair enough, would like to get away from that though :P
18:33:17
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @Ericson2314:matrix.org
Flakes are a "fast food" that kinda tastes good to start but ultimately fails to truly solve any problems
i think this is subjective. i really like flakes and for my usecases, they have almost completely replaced the stable tooling. but the other problems still stand, and it is factually still experimental, so I think we should focus on that, rather than value judgements
18:33:32

Show newer messages


Back to Room ListRoom Version: 6