!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

419 Members
Discussion about documentation improvements around the Nix ecosystem82 Servers

Load older messages


SenderMessageTime
24 Dec 2023
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @danielsidhion:nixos.dev
Also when going through this, I'm starting to create issues for extra work that is either more than I can do at the moment, or is stuff that I'd try to revisit at some point. It improves either the documentation or stuff in Nixpkgs, and I think it's the sort of thing bzm3r would love to have to work on issues with very specific scope. Here are two issues I opened from my rewrite of that section:
https://github.com/NixOS/nixpkgs/issues/276033
https://github.com/NixOS/nixpkgs/issues/276034
danielsidhion: thank you! (I'm also very glad that you did decide to ping me re: looking into these issues)
08:26:58
@bzzm3r:matrix.org@bzzm3r:matrix.org(so please feel free to continue to ping me on such stuff, both here, and on GitHub)08:28:52
@bzzm3r:matrix.org@bzzm3r:matrix.org * (so please continue to ping me on such stuff, both here, and on GitHub)08:29:10
@jkxyz:matrix.org@jkxyz:matrix.org set a profile picture.18:12:55
25 Dec 2023
@julienmalka:matrix.orgJulien changed their display name from Julien to Julien - DECT 4575.20:03:43
26 Dec 2023
@danielsidhion:nixos.devdanielsidhionAlso had to change a bit of content on this one, but at a way smaller scale: https://github.com/NixOS/nixpkgs/pull/276821 When working on it, I realised the manual doesn't seem to follow a convention for shell commands and their outputs, and created the following issue to track this: https://github.com/NixOS/nixpkgs/issues/276829 I'll put this issue on the agenda for some meeting next year, but I'm hoping it won't take long to achieve consensus. Once we have one, I can add it to my list of "things to update while I go through every file of the nixpkgs manual".02:03:50
@matthewcroughan:defenestrate.itmatthewcroughan changed their display name from matthewcroughan - nix.how to matthewcroughan - Linux 6.7 When.16:48:35
27 Dec 2023
@nikstur:matrix.orgnikstur changed their display name from nikstur to nikstur (DECT 5643).09:49:16
29 Dec 2023
@mcdonc:matrix.orgChris McDonough joined the room.13:03:47
@mcdonc:matrix.orgChris McDonoughhi folks... fyi, i submitted a PR for improving trivial builder text-related functions at https://github.com/NixOS/nixpkgs/pull/277534 ...i'd appreciate it if someone could review it and maybe merge?13:05:23
30 Dec 2023
@asymmetric:matrix.dapp.org.ukasymmetric Robert Hensing (roberth): about https://github.com/NixOS/nixpkgs/pull/167670#issuecomment-1872501084, do you mean that you'd like to see more documentation before this is exposed to users? 10:54:19
@asymmetric:matrix.dapp.org.ukasymmetric * Robert Hensing (roberth): about https://github.com/NixOS/nixpkgs/pull/167670#issuecomment-1872501084, do you mean that you'd like to see more documentation before this is exposed to lots users via 2023 recap? 10:54:32
@asymmetric:matrix.dapp.org.ukasymmetric * Robert Hensing (roberth): about https://github.com/NixOS/nixpkgs/pull/167670#issuecomment-1872501084, do you mean that you'd like to see more documentation before this is exposed to lots of users via 2023 recap? 10:54:42
@roberthensing:matrix.orgRobert Hensing (roberth)Just to set expectations in the recap10:54:44
@roberthensing:matrix.orgRobert Hensing (roberth)I think it's sufficiently documented10:54:53
@roberthensing:matrix.orgRobert Hensing (roberth)Though maybe the part about it consisting of a single derivation isn't actually10:55:34
@roberthensing:matrix.orgRobert Hensing (roberth)hmm10:55:38
@asymmetric:matrix.dapp.org.ukasymmetric Robert Hensing (roberth): afaict this is ready to be merged, do you agree? https://github.com/NixOS/nixpkgs/pull/277171 11:42:19
@asymmetric:matrix.dapp.org.ukasymmetricif so i'll reopen and merge11:42:22
@roberthensing:matrix.orgRobert Hensing (roberth)maybe I overreacted. The pr was probably fine11:43:52
@mcdonc:matrix.orgChris McDonough asymmetric: i have something of a competing PR (a bit silly) at https://github.com/NixOS/nixpkgs/pull/277534 ... i think it atually addresses most of your comments, but likely none of Robert's 12:17:51
@mcdonc:matrix.orgChris McDonoughi think it improves on the original PR by specifying whether the derivaion produced will be a file or a directory, and demonstrates how you might use bare writeTextFile to do the job of each writeText*/writeScript*/writeShellScript* function12:20:16
@mcdonc:matrix.orgChris McDonoughit also breaks out each function into a top-level thing12:20:52
@mcdonc:matrix.orgChris McDonoughah nevermind i did not notice it was already merged. i will propose another pr against master.12:24:47
@mcdonc:matrix.orgChris McDonoughor was it? i guess he just closed it instead.12:29:52
@julienmalka:matrix.orgJulien changed their display name from Julien - DECT 4575 to Julien.18:43:51
@raitobezarius:matrix.orgraitobezarius changed their display name from raitobezarius (DECT 2128) to raitobezarius.19:53:20
31 Dec 2023
@aos1:matrix.orgaos Hey y'all - quick question: is there a way to build the nixpkgs manual using the provided flake? I see in https://github.com/NixOS/nixpkgs/blob/34d3d09834b52db5da25fb6f36055f4971709ee3/flake.nix#L57-L62 that the output: htmlDocs is exposed, but I don't think it's possible to build it? I tried nix build .#htmlDocs on a local checkout of nixpkgs repo, but that doesn't work 17:28:51
@danielsidhion:nixos.devdanielsidhion
In reply to @aos1:matrix.org
Hey y'all - quick question: is there a way to build the nixpkgs manual using the provided flake? I see in https://github.com/NixOS/nixpkgs/blob/34d3d09834b52db5da25fb6f36055f4971709ee3/flake.nix#L57-L62 that the output: htmlDocs is exposed, but I don't think it's possible to build it? I tried nix build .#htmlDocs on a local checkout of nixpkgs repo, but that doesn't work
htmlDocs is not a derivation - the error you got when running nix build .#htmlDocs says exactly that. If you look at the definition of htmlDocs in the flake, you'll see it specifies the nixpkgsManual and nixosManual attributes, and those are derivations you can build
17:36:55
@danielsidhion:nixos.devdanielsidhion Try nix build .#htmlDocs.nixpkgsManual or nix build .#htmlDocs.nixosManual 17:37:12

Show newer messages


Back to Room ListRoom Version: 6