Nix Documentation | 436 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 92 Servers |
| Sender | Message | Time |
|---|---|---|
| 8 May 2023 | ||
| no clue how to even do that | 19:00:15 | |
| the entire epub rendering chain is some cursed docbook nonsense | 19:00:26 | |
| Sorry, also didn't make the meeting today - day off with family in the UK. See you all on Thursday. | 19:01:07 | |
| i think we should drop docbook, and if someone is willing to add back support for it in nrd, they should do it. there will always be a handful of users who use a niche feature, but if that's not easy to support by the people actually doing the work (pennae in this case), then it should be dropped | 19:01:50 | |
| * i think we should drop epub, and if someone is willing to add back support for it in nrd, they should do it. there will always be a handful of users who use a niche feature, but if that's not easy to support by the people actually doing the work (pennae in this case), then it should be dropped | 19:01:55 | |
| a big deprecation notice will also mean that we'll have to keep docbook around for another six to twelve months :/ | 19:02:48 | |
| mmdoc has an epub export, heavy inspiration could be taken from that | 19:03:51 | |
| maybe it's feasible to render epub through docbook forever and drop docbook for everything else? haven't checked yet, but experiences with the nixos manual at least make it seem plausible. | 19:10:12 | |
| definitely not a good solution, but a solution | 19:10:24 | |
| I will eventually implement epub support in nrd, it’s not really that hard | 19:24:13 | |
| we just need splitting the manual into per-chapter HTML files, and then basically two TOC files | 19:25:14 | |
| plus few static files and then zipping everything | 19:25:28 | |
| toc generation should be easy, and splitting at computed marks is basically inserting a few marks into the ast after parsing | 19:27:21 | |
| If we want to drop the DB toolchain, I would just drop the epub output without notice for now and point people to https://duckduckgo.com/?q=html2epub | 19:30:05 | |
| nrd already collects full toc info for crossreferences, splitting already exists but has to be configured manually. that can totally be automated with a post-parse plugin | 19:30:49 | |
| heck the ast this thing uses is a mess 😞 | 19:33:52 | |
| 9 May 2023 | ||
| 07:36:44 | ||
| 07:54:13 | ||
| 08:02:08 | ||
| 09:04:06 | ||
| 21:16:47 | ||
| 10 May 2023 | ||
| Hey, I was wondering about the current status of the NixOS wiki. From reading its history page and the linked issue discussions I gather that there was some rather unsavory history leading to it now being inofficial and operated outside of the NixOS project since 2016. However, while the original plan when closing the original wiki seems to have been to move documentation from the wiki to the official manuals, that doesn't seem to have happened in any larger capacity in the years following the inofficialization. The wiki still seems to be the only place to have you-want-X-do-Y-instructions with usable snippets and stuff like that for most tasks. E.g. I was just searching for setting up printers, and there's no mention of printing in the manuals, but there is a wiki page (which is where I would expect something like that anyway from my experience with other distros). Also, for a lot of search queries on Google etc. of the type "nixos how to X" the wiki will come up first, because the manuals don't have a lot of stuff like that. The wiki is probably the de facto landing page for a lot of newbies to NixOS (see also this post of mine). Or for another there's no mention of how to set up Docker or Podman, no mention in the manual that I could find, but there are wiki pages with convenient snippets. Sadly, the wiki pages often are outdated or otherwise lacking, and I'd like to improve them. However, my problem is: is it a good idea to put effort in improving the wiki? Or am I wasting effort on a deprecated project that's not really part of the Nix documentation effort? And if the wiki is indeed supposed to be deprecated, are there plans to add more you-want-X-do-Y-instruction-stuff for NixOS to the manuals? Would my example of "how to set up a printer" be well-suited for the manuals and should I add something like that there? Or is it better suited for the wiki (like other distributions handle it), regardless of it being inofficial? In short, I mainly want to know where I'd best focus my efforts if I want to start helping on improving docs for how to do stuff on NixOS. If anyone has any insights of the situation or maybe some links to where I can keep reading up on it, I'd appreciate it! | 09:02:58 | |
| Also, I gather there are plans on switching site generators for the NixOS documentation? Would that possibly also mean a switch of the output theme? I find the manual being one very long page to be quite exhausting and think the NixOS and nixpkgs manuals would benefit from a better theme like the one the Nix manual uses. I couldn't find any issues on this right away, so that's why I'm asking whether that has been discussed before. | 09:07:21 | |
| Nicolas Lenz: basically, https://nix.dev is what you're looking for. it's an official project (even though the website doesn't reflect that, and we should absolutely change that asap), and it's supported by the nix documentation team. it's intended to be the place for how-to's (among other things), which as you correctly point out, are out of scope for a manual. if you want to contribute, you can just go ahead and file a PR, but you are also very welcome to ask questions here first, or hop on one of our meetings (in room desc) | 09:15:25 | |
| * Nicolas Lenz: basically, https://nix.dev is what you're looking for. it's an official project (even though the website doesn't reflect that, and we should absolutely change that asap), and it's maintained by the nix documentation team. it's intended to be the place for how-to's (among other things), which as you correctly point out, are out of scope for a manual. if you want to contribute, you can just go ahead and file a PR, but you are also very welcome to ask questions here first, or hop on one of our meetings (in room desc) | 09:15:41 | |
| fricklerhandwerk: do you know what's blocking us from making nix.dev look more official? Thinking of things like:
| 09:18:17 | |
| i.e. a mix of technical and bureaucratic steps, it seems. i'd be happy to file PR for the technical ones and help out with the legal/orga/bureaucratic ones, if that's possible | 09:19:11 | |
| i'm also not particularly attached to the nix.dev domain. at the risk of rehashing old discussions, i'd be fine with a subdomain of nixos.org (and think it could be even better, tbh) | 09:21:24 | |
| so if there are blockers around copyright transfer of nix.dev, this could be a way to sidestep those entirely | 09:21:50 | |
| * so if there are blockers around copyright transfer of nix.dev, this could be a way to sidestep those entirely, and solve visiblity from homepage and pagerank issues as well | 09:22:40 | |