!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

418 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
30 Dec 2023
@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
@aos1:matrix.orgaosOhhh... that makes total sense. I should've read the error better. Thank you :-)17:38:17
@philiptaron:matrix.orgPhilip Taron (UTC-8) changed their display name from Philip Taron to Philip Taron (UTC-8).18:10:48
1 Jan 2024
@nixinator:nixos.dev@nixinator:nixos.dev left the room.22:37:04
2 Jan 2024
@asymmetric:matrix.dapp.org.ukasymmetrichttps://jvns.ca/blog/2024/01/01/some-notes-on-nixos/11:19:49
@asymmetric:matrix.dapp.org.ukasymmetrici always find it useful to see what other people use to learn (how to do things with) nix, that's why i post it here11:25:57
@asymmetric:matrix.dapp.org.ukasymmetricit would be good to track how many new articles use nix.dev instead of the wiki. this uses the wiki11:26:55
@asymmetric:matrix.dapp.org.ukasymmetricbut for something that i'm not sure we should be maintaining ourselves? it seems like for things like "nixos friendly hosters", a wiki provides less friction11:27:48
@asymmetric:matrix.dapp.org.ukasymmetric * but for something that i'm not sure we should be maintaining ourselves? it seems like for low-stakes (?) things like "nixos friendly hosters", a wiki provides less friction11:27:57
@asymmetric:matrix.dapp.org.ukasymmetric * but for something that i'm not sure we should be maintaining ourselves? it seems like for low-stakes (?) things like "nixos friendly hosters", a wiki provides less friction for users and takes off some work from the docs team 11:28:18
@asymmetric:matrix.dapp.org.ukasymmetricor is the idea that everything that's now in nix.wiki + nixlang.wiki should eventually be absorbed by nix.dev?11:28:52
@asymmetric:matrix.dapp.org.ukasymmetric * but for something that i'm not sure we should be maintaining ourselves? it seems like for low-stakes (?) things like "nixos friendly hosters", a wiki provides less friction for users and takes off some work from the docs team's plate11:29:10
@asymmetric:matrix.dapp.org.ukasymmetric * but for something that i'm not sure we should be maintaining ourselves? it seems like for low-stakes (?) things like "nixos friendly hosters", a wiki provides less friction for users and takes some work off the docs team's plate11:29:18
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
or is the idea that everything that's now in nix.wiki + nixlang.wiki should eventually be absorbed by nix.dev?
Absolutely not. We certainly need a place for a class of crowd-maintained information, everything else is not manageable.
14:03:47
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @fricklerhandwerk:matrix.org
Absolutely not. We certainly need a place for a class of crowd-maintained information, everything else is not manageable.
do we have some rough principle of what should not go into nix.dev? i can think of "anything that doesn't fit diàtaxis", but that seems a bit unsatisfying
14:37:08
@fricklerhandwerk:matrix.orgfricklerhandwerk

A few unstructured thoughts:

  • instructions for specific software

    This is currently covered by the wiki to some extent, by NixOS/Home
    Manager/… option documentation, and upstream

  • reference documentation

    That should be in the manual for the respective component. There are a few violations of that at the moment

Conversely, what should go into nix.dev are things that don’t fit anywhere else: cross-cutting concerns that aren’t specific to any ecosystem component or don’t have a better place to live. Ideally that would be very little.

15:26:34
@asymmetric:matrix.dapp.org.ukasymmetricbut we've just moved the nix ref manual to nix.dev?15:30:59

Show newer messages


Back to Room ListRoom Version: 6