!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

433 Members
Discussion about documentation improvements around the Nix ecosystem90 Servers

Load older messages


SenderMessageTime
13 Nov 2023
@asymmetric:matrix.dapp.org.ukasymmetric I personally always have to invoke nix-shell -I nixpkgs= ... 12:55:39
@asymmetric:matrix.dapp.org.ukasymmetric

even though

❯ echo $NIX_PATH
nixpkgs=/nix/store/sd0xal2sd16vwgpba0z7cwr6zylp3axk-z6w242l49pbrdawkz5vdhfxh2mvsj36c-source
12:56:21
@asymmetric:matrix.dapp.org.ukasymmetric maybe we need to tweak NIX_PATH when installing nix on the runner? 12:56:53
@fricklerhandwerk:matrix.orgfricklerhandwerkHere's the upstream issue: https://github.com/NixOS/nix/issues/889013:00:42
14 Nov 2023
@bzzm3r:matrix.org@bzzm3r:matrix.org left the room.09:36:36
@nbp:mozilla.orgnbp I do not want to be the devil advocate, but I just listen to an argument in a video roughly paraphrasing: "Due to the lack of proper documentation, Youtube videos about NixOS are doing well" 10:33:36
@nbp:mozilla.orgnbp * I do not want to be the devil advocate, but I just listen to an argument in a video roughly paraphrasing: "Due to the lack of proper documentation, Youtube videos about Nix are doing well" 10:34:20
@j-k:matrix.orgj-kAh, Oxford University and Oxford University Press diverge on ize ise11:14:40
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @nbp:mozilla.org
I do not want to be the devil advocate, but I just listen to an argument in a video roughly paraphrasing: "Due to the lack of proper documentation, Youtube videos about Nix are doing well"

That video seems to be about NixOS, in which case that statement is a fair assessment. NixOS documentation is certainly not in a good shape and essentially unmaintained content-wise.

Nixpkgs has a huge surface and we can barely scratch that with available capacity, but it’s very slowly getting better. There are also a lot of infrastructure issues, going deep down into the code.

Nix itself is much more manageable in terms of system size and complexity, so progress is more visible there. But there are the same kind of structural problems that really need to be addressed at the code level to unblock sweeping improvements documentation.

14:01:20
@fricklerhandwerk:matrix.orgfricklerhandwerkEveryone is invited to take some ownership! The documentation team will gladly help anyone interested to get into the subject. We have meetings twice a week to ask questions, get some hand-holding, and discuss proposals and changes.14:02:50
@bzzm3r:matrix.org@bzzm3r:matrix.org joined the room.18:39:14
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @nbp:mozilla.org
I do not want to be the devil advocate, but I just listen to an argument in a video roughly paraphrasing: "Due to the lack of proper documentation, Youtube videos about Nix are doing well"

except most community-based information of this sort is either:

  1. wrong

  2. propagating unhelpful practices

  3. more of the "first we copy this" "then we paste this" variety

18:40:17
@bzzm3r:matrix.org@bzzm3r:matrix.orgso its really easy to end up wasting time on a resource, until someone who knows better corrects you18:40:41
@bzzm3r:matrix.org@bzzm3r:matrix.org

Anyway, I'm interested in contributing a series of small packages to nixpkgs which are meant to serve as documented examples/best-practices for how to make packages for various languages using the Nix language (i.e. no use of nix-community tools, and extremely conservative use of overlay/override: only when there is no other option).

Likely these can also be referenced in the docs, but for now, my goal is in particular, to get the examples out.

Do you all think this makes sense as a project? If it does then: as I am a complete Nix beginner (I have just gotten my NixOS setup stable after 2+ weeks of work), I would really benefit from being able to ask for help (the alternative is to get side-tracked with random information from the internet, until I am ultimately corrected by someone who knows better). Where would it be appropriate for me to ask questions without worry/judgement?

18:45:52
@bzzm3r:matrix.org@bzzm3r:matrix.org(One possible solution for the last point is to have a dedicated Discourse thread for each particular example I am building?)18:46:18
@bzzm3r:matrix.org@bzzm3r:matrix.orgIf my labour/effort would be better spent elsewhere, I am happy to do that instead too. In general I would like to help with documentation/wiki-style documentation18:47:02
@bzzm3r:matrix.org@bzzm3r:matrix.org(Also, for now, I only plan to tackle the following "major" languages, and this might already be too big a list: Rust, Haskell, TypeScript/JavaScript, Python, Go, C, C++)18:49:30
15 Nov 2023
@grahamc:nixos.org@grahamc:nixos.orgchanged room power levels.16:08:27
@grahamc:nixos.org@grahamc:nixos.org left the room.16:08:28
@qyliss:fairydust.spaceAlyssa Ross 17:10:42
@mjolnir:nixos.orgNixOS Moderation Botchanged room power levels.18:12:13
@mjolnir:nixos.orgNixOS Moderation Botchanged room power levels.18:12:13
@infinisil:matrix.orginfinisil bzm3r: Hey, glad to see interest in helping out the documentation! 20:42:44
@infinisil:matrix.orginfinisil bzm3r: There's a docs team meeting tomorrow at 16:00 CET (see the NixOS calendar), could you join there? 20:43:55
@infinisil:matrix.orginfinisilEven if you can't make it, we can discuss your idea there :)20:44:50
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @bzzm3r:matrix.org

Anyway, I'm interested in contributing a series of small packages to nixpkgs which are meant to serve as documented examples/best-practices for how to make packages for various languages using the Nix language (i.e. no use of nix-community tools, and extremely conservative use of overlay/override: only when there is no other option).

Likely these can also be referenced in the docs, but for now, my goal is in particular, to get the examples out.

Do you all think this makes sense as a project? If it does then: as I am a complete Nix beginner (I have just gotten my NixOS setup stable after 2+ weeks of work), I would really benefit from being able to ask for help (the alternative is to get side-tracked with random information from the internet, until I am ultimately corrected by someone who knows better). Where would it be appropriate for me to ask questions without worry/judgement?

If you can devote time to that, it would be a blast. There's a fairly old issue about it here, but it's still on the radar: https://github.com/NixOS/nix.dev/issues/278

You'll surely get lots of feedback on the didactic part and about generic Nix aspects from the docs team, and it may be worth upstreaming things into Nixpkgs on the side to get maintainer feedback for stylistic.

And while I really don't want to hamper your enthusiasm, expect it to be a big project that may not terminate within your available time. The reference documentation is often so sparse it's useless. Start out with one language, do a cheap draft and bounce it against us.

20:48:58
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @bzzm3r:matrix.org

Anyway, I'm interested in contributing a series of small packages to nixpkgs which are meant to serve as documented examples/best-practices for how to make packages for various languages using the Nix language (i.e. no use of nix-community tools, and extremely conservative use of overlay/override: only when there is no other option).

Likely these can also be referenced in the docs, but for now, my goal is in particular, to get the examples out.

Do you all think this makes sense as a project? If it does then: as I am a complete Nix beginner (I have just gotten my NixOS setup stable after 2+ weeks of work), I would really benefit from being able to ask for help (the alternative is to get side-tracked with random information from the internet, until I am ultimately corrected by someone who knows better). Where would it be appropriate for me to ask questions without worry/judgement?

*

If you can devote time to that, it would be a blast. There's a fairly old issue about it here, but it's still on the radar: https://github.com/NixOS/nix.dev/issues/278

You'll surely get lots of feedback on the didactic part and about generic Nix aspects from the docs team, and it may be worth upstreaming things into Nixpkgs on the side to get maintainer feedback on style and conventions.

And while I really don't want to hamper your enthusiasm, expect it to be a big project that may not terminate within your available time. The reference documentation is often so sparse it's useless. Start out with one language, do a cheap draft and bounce it against us.

20:49:21
@eisfunke:eisfunke.com@eisfunke:eisfunke.com changed their profile picture.22:41:23
16 Nov 2023
@infinisil:matrix.orginfinisil asymmetric: Ping regarding the transfer of nixdoc 00:37:17
@i97henka:matrix.orghenrik-chI won't be able to join the doc meeting today. Have a good session!14:24:26

Show newer messages


Back to Room ListRoom Version: 6