Nix Documentation | 436 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 92 Servers |
| Sender | Message | Time |
|---|---|---|
| 20 May 2023 | ||
| personally i was kind of imagining a reference-style thing where there's a Q&A matrix and then based on your answers you can get directed to a section explaining how to install a package given your answers to the question | 22:24:22 | |
| questions including things like "are you on nixos", "is it in nixpkgs", "are you using flakes", "do you want it installed globally or for your user only", "do you want it installed permanently or just to use it temporarily", etc | 22:25:12 | |
| * personally i was kind of imagining a reference-style thing where there's a Q&A matrix and then based on your answers you can get directed to a section explaining how to install a package given your answers to the questions | 22:26:10 | |
| * questions including things like "are you on nixos", "is it in nixpkgs", "are you using flakes", "do you want it installed globally (configuration.nix), for your user only (home-manager), or in a specific project environment only (shell.nix)", "do you want it installed permanently (declarative) or just to use it temporarily (nix-shell)", etc | 22:27:46 | |
| (i don't have particularly strong feelings as to exactly how this information is presented, i'm just throwing some ideas around) | 22:30:13 | |
| 21 May 2023 | ||
does anyone understand sphinx? i'd like to add a link to the footer on nix.dev, but i can't find a way to do that. apparently i have to override the footer block in the default layout, but when i do, my HTML doesn't end up in the footer element | 16:42:09 | |
| 22 May 2023 | ||
| Iโll take a look, sometimes that kind of config is in conf.py at the top level of the repo | 12:33:25 | |
| 23 May 2023 | ||
| We have release notes for nixos but we don't really have anything for nixpkgs itself, has this been raised before? buildFHSEnv moving from the chroot version to bubblewrap has broken a couple things and will be pretty much invisible to people updating to 23.05. There's a comment in all-packages.nix but that's not particularly visible https://github.com/NixOS/nixpkgs/pull/225748 | 13:30:31 | |
it's really the nixos releases usually | 13:31:13 | |
| this has been raised before by multiple contributors | 13:31:21 | |
| Minijackson I found this, in case it might help you! https://vi.stackexchange.com/questions/2846/how-to-set-up-vim-to-work-with-one-sentence-per-line | 17:15:01 | |
| ooooh, thanks a lot! I'll certainly try this ^^ | 17:15:39 | |
| 25 May 2023 | ||
| I wonโt be able to attend today, sorry! | 13:00:30 | |
| 13:32:21 | ||
| 13:37:27 | ||
| 26 May 2023 | ||
| zmitchellfricklerhandwerk: do we have any feedback about keeping/dropping the epub export (temporarily) yet? | 15:07:25 | |
In reply to @pennae:matrix.eno.spaceHow about we change the epub to be just a single page telling users that it's deprecated and linking to the html manual instead. Also to report it in an issue if somebody depends on epub. | 15:42:26 | |
| we can do that. all we need is a decision which way to go | 15:43:06 | |
| If we don't have any feedback to epub, I think that idea is what we should do. In particular now that the release is branched off, so users have lots of time to report that they need epub until the next release | 15:44:20 | |
| if anyone wants to implement epub export in nixos-render-docs before that (jan tojnar offered i think) we can keep it too | 15:44:23 | |
| The epub feels like baggage we don't really have the resources to maintain, so I'd rather drop it until we have a significant user base that needs it | 15:45:11 | |
| * The epub feels like baggage we don't really have the resources to maintain, so I'd rather drop it unless we have a significant user base that needs it | 15:45:20 | |
| keeping docbook around to produce a placeholder epub that only as a link and a deprecation notice is just so ironic | 15:48:06 | |
| but that's fine too. we're just not going to start moving properly on the nixpkgs manual conversion and removing docbook from the nixos manual completely until this is fixed. maybe we should have a vote or something | 15:49:14 | |
pennae: It's effectively a constant document at that point, so docbook generation wouldn't even be necessary anymore, I'd be fine with it just being a rendered epub hosted somewhere that we just pkgs.fetch* :P | 16:13:11 | |
nixos/doc/epub/is-deprecated.epub | 16:14:13 | |
| sure, also fine. amounts to dumping a blob into git which doesn't feel too nice, but it's small enough vs the rest of nixpkgs to not matter :) | 16:14:54 | |
| Oh yeah that sounds good too ๐ | 16:15:24 | |
| nixos manual could drop docbook today if we (even just temporarily) deprecate docbook, nixpkgs manual is a bit out but shouldn't be by too much. we've experimented in the past and got the manual to render, but haven't checked for content equality and it's been a few months now too | 16:20:43 | |
| https://nixos.org/learn.html is broken again, in the same way as quite some time ago | 22:15:38 | |