!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

435 Members
Discussion about documentation improvements around the Nix ecosystem90 Servers

Load older messages


SenderMessageTime
15 Oct 2023
@nonuke:matrix.orgnonukeas a matter of fact, when I ls the path, there is no executable there... What am I missing?07:44:29
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
Als Antwort auf @fricklerhandwerk:matrix.org
This looks great. Still, as @roberth suggested elsewhere recently, we should not encourage using builtins to keep separation of concerns. I suggest rendering what you have to the Nixpkgs manual. It would also avoid getting into hairy consistency problems between Nix and Nixpkgs documentation. The nix.dev reference section should ideally consist only of links to the manuals, but some things are currently hard to do in an ideal way.
Thanks. I think reference documentation must be complete first. Then wie can add opinionated help/practices like: „dont use Builtins in nixpkgs because…“
Not having the documentation in one place is not enjoyable for most users. Most of the time you just need to get it work first then you learn about how to do it the (maybe opinionated) right way.
07:45:39
@Minijackson:matrix.orgMinijacksonhey there! Note that this channel is not a general help channel, unless it's about the documentation itself07:46:34
@nonuke:matrix.orgnonukeSorry, I've just noticed I am writing on the wrong channel.07:46:48
@Minijackson:matrix.orgMinijackson but for your error, I think it comes from $/out/bin which needs to be $out/bin 07:47:03
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostand by reference documentation i mean „dumb“ and Objektive explanation how to call a function. And Not how to use it the right way. We should try to seperate opinionated Tutorials/Exemplar and un-opinionated api descriptions07:49:51
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host* and by reference documentation i mean „dumb“ and Objektive explanation how to call a function. And Not how to use it the right way. We should try to seperate opinionated Tutorials/examples and un-opinionated api descriptions07:50:20
@jade_:matrix.org@jade_:matrix.org joined the room.22:02:17
@jade_:matrix.org@jade_:matrix.orgI have a long post of feedback which tbf is mostly probably stuff we already know, sourced from a friend. Is this the right place to put it or should it go on discourse?22:03:48
@jade_:matrix.org@jade_:matrix.org* I have a long post of feedback which tbf is mostly probably stuff we already know, sourced from a friend who just learned NixOS. Is this the right place to put it or should it go on discourse?22:04:00
@jade_:matrix.org@jade_:matrix.org

Oh, an update on me learning nix stuff and just some introspection: Since the manual is better than the wiki, the wiki is more of a hindrance than an advantage because it's outdated. I'd honestly prefer the manual to be the default result when i google something (but that needs some cute SEO).

(jade): it sucks that our manual is incredibly anti seo because the fact that it's one massive page is incredibly nice to ctrl f and not have to trust some terrible in-page search engine. but the upgrade ryantm is doing would help here i think.

The manual is a nice resource for certain things especially initial setup, but there's a lack of (readily accessible) resources to do customisations like adding nvim plugins, etc. I understand that it's just adding config files like normal distros now.. But that brings up a suggestion of being more clear about the NixOS philosophy. I get that it's highly reproducible, but what exactly is reproducible. What are the things I should aim to replicate with my configurations (is it just my packages and development environments?, or does it also include my shell and text editor configuration? Are my flatpak apps supposed be included in this reproducible build for best practices? how am i supposed to even go about doing this?). While I get that it's honestly up to you, I would highly prefer a guide on how to set up my OS with best practices or really avoid bad practices like nix-env -i

Also the obvious thing remains obvious in terms of documentation missing really explaining what a flake is? I got it at the end, but wow it took me a while. The communication of flakes seems like it's to a systems expert rather than someone who has intermediate or novice skills with sysmgmt.

(jade): especially it's hard to find it in the nix manual and we're doing no favours by having our manuals all separated so that you can't search in one to find things in the other. global search across nix.dev, nix, nixpkgs, and nixos docs would be good maybe?

But also the community is really good like I found this really useful guide which I don't know if you already know which does a good job imo: https://nixos-and-flakes.thiscute.world/ (it's not perfect, but does a good job nonetheless)

22:09:55
17 Oct 2023
@ryantm:matrix.orgryantmI'm planning to merge this in one week unless I get feedback about it. https://github.com/NixOS/nixpkgs/pull/108063/files it's a fairly self contained change.13:20:48
@artturin:matrix.orgArtturin
In reply to @ryantm:matrix.org
I'm planning to merge this in one week unless I get feedback about it. https://github.com/NixOS/nixpkgs/pull/108063/files it's a fairly self contained change.
Doesn't seem that it's been linked to from https://github.com/NixOS/nixpkgs/issues/156309
It's not mdbook but it's about creating a paged docs
16:49:24
19 Oct 2023
@fricklerhandwerk:matrix.orgfricklerhandwerkI'm likely not going to make it to the meeting today. If there is anything anyone really needs to discuss or review or get merged today, please ping me and I will try to arrange it regardless.08:14:57
@infinisil:matrix.orginfinisil Today me and henrik-ch started curating the doc team member list: https://discourse.nixos.org/t/2023-10-19-documentation-team-meeting-notes-87/34349 14:55:27
@infinisil:matrix.orginfinisil henrik-ch: See the edit history of the meeting notes, did minor updates 14:58:14
20 Oct 2023
@zmitchell:matrix.org@zmitchell:matrix.orgI finally have a PR up for sphinxext-rediraffe: https://github.com/NixOS/nixpkgs/pull/26218204:38:16
@ninjatrappeur:alternativebit.fr@ninjatrappeur:alternativebit.fr changed their display name from NinjaTrappeur to PicNoir (was Ninjatrappeur).10:34:34
@ckie:ckie.devmei 🌒& hey so the docs for fixed-output derivations don't have any direct mention of the fact they enable network access? only implications with the fetchurl example? 19:33:33
@ckie:ckie.devmei 🌒&and that regular derivations don't, at least when the sandbox is enabled which I think is basically always?19:35:38
21 Oct 2023
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @ckie:ckie.dev
hey so the docs for fixed-output derivations don't have any direct mention of the fact they enable network access? only implications with the fetchurl example?
Yes, apparently. Would you mind adding a sentence that mentions this?
09:52:09
@fricklerhandwerk:matrix.orgfricklerhandwerk

If you need some guidance to make the change, check this new page: https://nixos.org/manual/nix/unstable/contributing/documentation

It likely won’t cover everything you need, and I’d be happy about feedback on how to improve it

09:53:30
@alejandrosame:matrix.orgalejandrosameIs the team aware of this PR: https://github.com/NixOS/nixpkgs/pull/108063?14:10:41
@proofconstruction:matrix.orgproofconstructionHave been very busy but will be able to review some stuff this weekend14:32:26
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @alejandrosame:matrix.org
Is the team aware of this PR: https://github.com/NixOS/nixpkgs/pull/108063?
Aware but have no opinion about it.
16:20:40
22 Oct 2023
@i97henka:matrix.orgi97henka
In reply to @alejandrosame:matrix.org
Is the team aware of this PR: https://github.com/NixOS/nixpkgs/pull/108063?
I am aware of it - was looking at it at nixcon with ryantm .
11:29:45
@asymmetric:matrix.dapp.org.ukasymmetricis there a reason why for the module system, we say "defining an option" instead of "setting an option"? I feel like i have to think a couple seconds every time i read definition/declaration, to remember what each means. this wouldn't happen with setting/declaration15:21:40
@stefanwschroeder:matrix.orgStefan Schroeder joined the room.19:44:10
23 Oct 2023
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
is there a reason why for the module system, we say "defining an option" instead of "setting an option"? I feel like i have to think a couple seconds every time i read definition/declaration, to remember what each means. this wouldn't happen with setting/declaration

Robert Hensing (roberth) wrote a proposal on changing that: https://github.com/NixOS/nixpkgs/issues/185234

I think it should be implemented as written. There's a pile of issues on module system docs, this is one of it.

09:41:45
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
is there a reason why for the module system, we say "defining an option" instead of "setting an option"? I feel like i have to think a couple seconds every time i read definition/declaration, to remember what each means. this wouldn't happen with setting/declaration
*

Robert Hensing (roberth) wrote a proposal on changing that: https://github.com/NixOS/nixpkgs/issues/185234

I think it should be implemented as written. There's a pile of issues with the module system docs, this is one of it.

09:42:05

Show newer messages


Back to Room ListRoom Version: 6