Nix Documentation | 419 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 86 Servers |
| Sender | Message | Time |
|---|---|---|
| 18 Dec 2023 | ||
| so errr. yeah there are political reasons but oddly enough, the official docs are essentially completely not flakes. and i agree that every random blog post telling you to use home manager is pretty sad. | 05:18:10 | |
In reply to @jade_:matrix.orgWell, not so odd, now that I know more. But when I started out, I heard from others, and thought myself, that this is "only because they're outdated, and the docs team is sleeping" | 05:19:16 | |
| so I actually tuned the official docs out, because clearly, I should be using flakes, right? | 05:19:38 | |
In reply to @jade_:matrix.org* Well, not so odd, now that I know more. But when I started out, I heard from others, and thought myself, that this is "only because they're (the official docs) outdated, and the docs team is sleeping" | 05:20:06 | |
| It's really hard to communicate the status of flakes to a newbie | 05:21:19 | |
| or to anyone who doesn't already know, frankly | 05:21:50 | |
| the biggest thing that's hard to communicate is how much they don't actually matter | 05:22:35 | |
In reply to @tejing:matrix.orgYup, which is why I think that a value-judgement-free route is to explicitly say: "hey, flakes have some cool ideas, but you'll have a smoother start without them, and once you're set, you'll find it much easier to use and understand them" | 05:22:50 | |
| you can use them, or not use them. It doesn't have much actual impact on what you can and can't do, or how easy or hard it is | 05:23:00 | |
| every newbie and his brother is convinced everything under the sun "requires flakes"... I suspect because they're doing a lot of their learning from people who don't actually understand things themselves all that well, and only learned flakes | 05:24:16 | |
| so they just aren't aware that all this stuff is just as doable without them | 05:24:41 | |
In reply to @tejing:matrix.orgpartly! but also, in my case, I'm not ashamed to admit that some of the places talking from the flakes angle had really good graphic design | 05:24:53 | |
| and therefore, an aura of respectability, professionalism | 05:25:00 | |
| when I started out, I thought the DetSys Nix installer was a the NixOS installer | 05:25:23 | |
| https://zero-to-nix.com/ <--- looks like the "real deal" | 05:26:25 | |
| yeah, it's odd that way. nix is kinda still in the stage of that mad scientists gizmo with a bunch of levers sticking out at odd angles... the most in-touch resources regarding how it works tend to look a bit similar >.<. It takes a bit to realize that. | 05:26:49 | |
| I'll also mention this tidbit here in case others find it a little useful: We talk about the relationship between how nix manages files and how programming languages deal with pointers, but for some reason when it comes to explaining why we avoid well-known paths, nobody seems to make the comparison to avoiding global variables | 05:31:58 | |
In reply to @tejing:matrix.org Could it be, to some extent, because Nix's current tooling relies fairly heavily on things like environment variables? I'm reminded of | 05:36:53 | |
| But overall, that way of using Nix to explain things to beginners is super under-used. | 05:37:24 | |
| * But overall, that way of using Nix to explain things to beginners is under-used (and therefore has a lot of opportunity). | 05:38:12 | |
In reply to @bzzm3r:matrix.orgI think most of the noise is not intentional. The difficult part of improving the documentation is not to add content but to make it more concise. So i basically agree with your observations. | 08:05:12 | |
| And the reason we're circling around these issues are embedded in bzm3r's long introduction that started this exchange: as a group of developers working on the ecosystem, we lack focus and direction, and this is in part because there are so many rabbit holes. There are more problems to solve than hours available, and each of them is large enough to get frustrated and switch to something else. Therefore everything is notoriously unfinished. | 08:05:59 | |
In reply to @olafklingt:matrix.orgWhile i was pondering on what i could recommend bzm3r: i realized that it might be not easy for beginners to take up the task of making things more concise. (I for example where not able yet to do so). ... maybe it still makes sense to pickup one topic and document it with a clear objective. So that others can find the things that can be reduced because of new tutorial/guide/.... | 08:29:23 | |
In reply to @olafklingt:matrix.orgJust to be clear, I'm not talking about the intentional obfuscation being due to the nix docs or devs. | 09:27:46 | |
In reply to @olafklingt:matrix.org* Just to be clear, I'm not talking about the intentional obfuscation being due to the nix documentaiton devs. | 09:27:58 | |
| But there is enough of an effort to delegitimize the current official docs (because they do not cover flakes, and because they refer to flakes as experimental features), that most newcomers (myself included) | 09:29:47 | |
| * But there is enough of an effort to delegitimize the current official docs (because they do not cover flakes, and because they refer to flakes as experimental features), that most newcomers (myself included) did not realize that flakes were entirely optional instead, we saw the docs as entirely outdated | 09:31:18 | |
In reply to @bzzm3r:matrix.org I for myself decided to see it this not worth to deal with. It is something one has to live with in a world with multiple opinions and unequal distribution of power. Obviously it's unfortunate. | 09:49:52 | |
In reply to @fricklerhandwerk:matrix.org Suppose you were to put on an imaginary despot's hat. Where would you direct efforts? Would it still be on documentation? If yes, then in that case, I found this recently: https://github.com/orgs/NixOS/projects/15/views/1 How can I find someone willing to prioritize tasks for me by assigning them to me? Could you do so? | 09:50:44 | |
| (I can make decisions based on my own sensibilities, of course, and am willing to do so if that is preferred.) | 10:00:07 | |