!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

383 Members
This is the official channel for documentation in the Nix ecosystem. The documentation team meets here. More information: https://nixos.org/community/teams/documentation Video conference: https://jitsi.lassul.us/nix-documentation Meeting notes scratch pad: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA Past meeting notes: https://discourse.nixos.org/search?q=documentation%20team%20meeting%20order%3Alatest 70 Servers

Load older messages


SenderMessageTime
5 Jan 2024
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @danielsidhion:nixos.dev
Also as discussed in the meeting, here's a quick overview of what I'm doing: for no reason at all, I decided it would be a good idea to go through the Nixpkgs manual source and update all examples to the admonition syntax as specified in the doc readme. As I did this, I realised that other things could also be updated to follow a more consistent style, and I also started finding a lot of outdated content in the manual, which I'm making an effort to also update. More than one person has asked how they could help, so I created a tracking issue here: https://github.com/NixOS/nixpkgs/issues/278769
* I wonder if we could get an LLM to tackle these refactors? It seems pretty algorithmic, and like it should work, but I have no experience with them so I don’t really know
10:07:55
@danielsidhion:nixos.devdanielsidhionThe algorithmic part of this effort is too small compared to the human effort still required. I'm also reading and updating the content (biggest effort, since it requires research in most cases, but I consider it outside the scope of the work, I just can't help trying to make things better), making sure the code in the examples can be run (sometimes I have to go find something from nixpkgs instead of going with the generic stuff in some examples), and looking for other things that could be adopted as a convention to bring more consistency to the manual11:16:43
@danielsidhion:nixos.devdanielsidhionThe dockerTools section is very long, so I'm going to create PRs for each subsection. I won't attend the meeting on Monday, but I'd appreciate if you folks could review https://github.com/NixOS/nixpkgs/pull/278956 if you have the time to do it there!16:58:46
@9999years:matrix.org@9999years:matrix.org set a profile picture.21:01:27
@9999years:matrix.org@9999years:matrix.org changed their profile picture.21:01:49
6 Jan 2024
@oliviacrain:matrix.org@oliviacrain:matrix.org joined the room.18:07:55
9 Jan 2024
@matthewcroughan:defenestrate.itmatthewcroughan @fosdem changed their display name from matthewcroughan - Linux 6.7 When to matthewcroughan.08:38:33
@asymmetric:matrix.dapp.org.ukasymmetric Regarding this issue, in the event the documentation team were to receive some funds, I wonder how prepared we would be, in terms of distributing funds, both to people and to tasks. fricklerhandwerk you probably have experience here? Is there some document that it would make sense to take a look at before this call? 09:19:19
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
Regarding this issue, in the event the documentation team were to receive some funds, I wonder how prepared we would be, in terms of distributing funds, both to people and to tasks. fricklerhandwerk you probably have experience here? Is there some document that it would make sense to take a look at before this call?
As always when getting money, there needs to be some setting goals and coordination. There is also Google Season of Docs coming up again, and preparing a project for applying would be good. We have some preliminary work back from the STF application in June that could be built upon.
11:39:55
@jade_:matrix.org@jade_:matrix.orghttps://github.com/NixOS/nixpkgs/pull/252091 is now rebased and ready to review13:48:58
10 Jan 2024
@philipp:xndr.de@philipp:xndr.de changed their display name from philipp to philipp (prolog in linux kernel, when).13:47:04
@philipp:xndr.de@philipp:xndr.de changed their display name from philipp (prolog in linux kernel, when) to philipp (prolog in linux kernel when).13:47:14
@philipp:xndr.de@philipp:xndr.de changed their display name from philipp (prolog in linux kernel when) to test.13:47:50
@philipp:xndr.de@philipp:xndr.de changed their display name from test to philipp.13:49:29
@viper.:matrix.org@viper.:matrix.org left the room.15:39:51
@9999years:matrix.org@9999years:matrix.org

I read the entire nix docs but I think it's the kind of documentation that's only useful if you already kind of get what's going on. It feels like you have to gather the knowledge from various random blogs. Last time I checked there surprisingly was not a single book which covers nix. I feel like a comprehensive book which teaches nix from the ground up and explains all the different ways of using nix would really help me and I would purchase such a book without hesitation if it existed.

still lots of work to do with the nix docs
https://news.ycombinator.com/item?id=38930947

17:43:11
@9999years:matrix.org@9999years:matrix.org

And I don't mind reading 'code as docs' in general but it's pretty much required here.

this sentiment remains, even from people enthusiastic about nix...
https://news.ycombinator.com/item?id=38931306

17:52:03
11 Jan 2024
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @9999years:matrix.org

I read the entire nix docs but I think it's the kind of documentation that's only useful if you already kind of get what's going on. It feels like you have to gather the knowledge from various random blogs. Last time I checked there surprisingly was not a single book which covers nix. I feel like a comprehensive book which teaches nix from the ground up and explains all the different ways of using nix would really help me and I would purchase such a book without hesitation if it existed.

still lots of work to do with the nix docs
https://news.ycombinator.com/item?id=38930947

no.
20:15:48
@mcdonc:matrix.orgChris McDonough"no"?20:23:26
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @mcdonc:matrix.org
"no"?
precisely.
20:24:37
@mcdonc:matrix.orgChris McDonoughspeechless20:25:15
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @mcdonc:matrix.org
speechless

It was a short, low content message, and it's not clear what the point of it was.

The simplest way to respond to it that wasn't "this is incorrect because....", is to disagree with a "no".

20:26:12
@bzzm3r:matrix.org@bzzm3r:matrix.orgBut it is extremely off-bse.20:26:24
@bzzm3r:matrix.org@bzzm3r:matrix.org * But it is extremely off-base.20:26:32
@mcdonc:matrix.orgChris McDonoughyou know, i submitted a pr a while back to the nixpkgs docs... and i attended a docs meeting in jitsi... and i volunteered to help.. but i'm starting to have second thoughts20:27:11
@mcdonc:matrix.orgChris McDonoughthere is no upside afaict20:27:43
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @mcdonc:matrix.org
you know, i submitted a pr a while back to the nixpkgs docs... and i attended a docs meeting in jitsi... and i volunteered to help.. but i'm starting to have second thoughts
Yeah, understandable. If you don't have the motivation or energy, you shouldn't force yourself.
20:28:00
@mcdonc:matrix.orgChris McDonoughalrighty then20:28:06
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @mcdonc:matrix.org
alrighty then

A little more carefully however, if I am understanding the subtext of your message properly:

  • if my comment is what is making you "lay down a threat", then consider that I am not a member of the Nix documentation team. You should base such decisions off of your interactions with the team leader (fricklerhandwerk) and their deputies (e.g. infinisil)

  • if you believe my message is "rude", you should consider whether or not the person I was responding to (who was not you, as far as I know), has bothered scrolling up to read some of the discussion in this channel.

But to be honest, it's very difficult to figure out your chain of comments.

20:33:40
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @mcdonc:matrix.org
you know, i submitted a pr a while back to the nixpkgs docs... and i attended a docs meeting in jitsi... and i volunteered to help.. but i'm starting to have second thoughts
please don't get discouraged, we appreciate your contributions (all contributions in fact)
20:41:09

Show newer messages


Back to Room ListRoom Version: 6