!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

415 Members
Discussion about documentation improvements around the Nix ecosystem87 Servers

Load older messages


SenderMessageTime
27 Oct 2022
@yuki:backalley.clubYuki (they/them) * I think a gradual progression from ad-hoc development environment -> declarative development environment -> reproducible and declarative development using the example project would be much better 15:13:25
@yuki:backalley.clubYuki (they/them)
In reply to @yuki:backalley.club
This reads more like a How-to guide while the other one reads more like a tutorial
https://diataxis.fr/tutorials-how-to/#tutorials-how-to
15:13:49
@yuki:backalley.clubYuki (they/them)
In reply to @yuki:backalley.club
I think a gradual progression from ad-hoc development environment -> declarative development environment -> reproducible and declarative development using the example project would be much better
I think a whole series called "How to use Nix on a project" would be better to serve as a getting started tutorial
15:16:40
@yuki:backalley.clubYuki (they/them)
In reply to @yuki:backalley.club
I think a gradual progression from ad-hoc development environment -> declarative development environment -> reproducible and declarative development using the example project would be much better
* I think a whole series called "How to use Nix on a project" would be better to serve as a getting started tutorial for a specific user story
15:17:02
@yuki:backalley.clubYuki (they/them)https://github.com/NixOS/nix.dev/pull/37615:27:48
@niksnut:matrix.orgniksnut joined the room.16:53:00
@planetjool:envs.netJool left the room.18:17:32
28 Oct 2022
@fricklerhandwerk:matrix.orgfricklerhandwerk

davidak: (in reply to your message on the Marketing channel) Yes the documentation team takes care of guides. I'm fully in favor of more guides, it's just that someone has to review them to make sure they are useful.

I proposed that right now we should focus on setting up a team of productive maintainers who can achieve that, and help people like you share their expertise effectively. So the following is really not to discourage you - I'd be really happy if we could have your ideas in there somehow - but I find it important to set expectations.

I don't see the documentation team working with you on your proposal any time soon. The main reason is that I think it covers a fairly niche use case, one that is not important for a majority of Nix beginners. We still have to more clearly define what those majority beginner use cases are, and that should be done after setting up the maintainer workflows.

The other reason is that I think it needs a lot of work, also on the reviewer side. Your sketch is just a piece of code, not a guide. It would at the very least least require linking to the reference documentation for specialisation. Here is another example which covers a valuable user story, but which I personally would not take into nix.dev as is. There is some more explanation about specialisations, but eventually the only thing presented is just another piece of code. A guide needs the steps how that piece of code is produced, and links to reference documentation for each individual part such that it becomes obvious to produce a piece of code that suits your specific problem.

The issue I have with these "here's a piece of code" solutions is that one has to fully understand it to derive the changes required to solve one's concrete problem instead of the one in the example. We cannot expect this from beginners. If the code would solve a generic problem, it may as well be in the library and kept invisible.

And while everyone is free to do as they please, I'd rather have everyone who wants to get involved focus on the low-hanging fruit first, and solve the bigger issues.

So, what about the following: Could you open an issue on nix.dev, collect some existing material there, and we observe the interest in this guide? (We're working on more firmly establishing a convention of people adding 👍️ to issues they want to have solved.)

09:02:43
@yuki:backalley.clubYuki (they/them)I remember someone at NixCon made a "Nixitionary" where it's essentially a glossary of Nix* terminologies. I wonder if it's online somewhere.16:19:30
@yuki:backalley.clubYuki (they/them) * I remember someone at NixCon made a "Nixitionary" where it's essentially a pamphlet with a glossary of Nix* terminologies. I wonder if it's online somewhere. 16:19:43
@alex:tunstall.xyzAlex
In reply to @yuki:backalley.club
I remember someone at NixCon made a "Nixitionary" where it's essentially a pamphlet with a glossary of Nix* terminologies. I wonder if it's online somewhere.
There's a glossary in the Nix manual: https://nixos.org/manual/nix/stable/glossary.html
16:23:46
@yuki:backalley.clubYuki (they/them)
In reply to @alex:tunstall.xyz
There's a glossary in the Nix manual: https://nixos.org/manual/nix/stable/glossary.html
Awesome, thanks!
16:22:03
29 Oct 2022
@chanceharrison:matrix.orgChanceHarrison joined the room.04:33:49
@alejandrosame:matrix.orgalejandrosame
In reply to @yuki:backalley.club
I remember someone at NixCon made a "Nixitionary" where it's essentially a pamphlet with a glossary of Nix* terminologies. I wonder if it's online somewhere.
https://nixionary.org/
09:32:22
@alejandrosame:matrix.orgalejandrosameHi! I've been trying to follow the links from nixos documentation team website, but it's still unclear to me what are the issues "up for grabs". Maybe I misunderstood the presentation during NixCon and there's no such a clear collection yet.09:38:23
31 Oct 2022
@tinybronca:sibnsk.netunderpantsgnome changed their display name from underpantsgnome! to underpantsgnome.20:18:24
1 Nov 2022
@fricklerhandwerk:matrix.orgfricklerhandwerk alejandrosame: Hi. Which web site exactly did you look at? The dust still hasn't settled on presenting that information consistently, so it would help immensely if you could point out to us what exactly you have seen. Here is an overview of the up-for-grabs small tasks: https://github.com/NixOS/nix.dev/blob/master/maintainers/how-to-contribute-to-documentation.md 08:26:12
@drtobbe:matrix.orgTobbeUh, nice link, that actually clarifies a lot. Just one thing I stumbled upon: Why is it "manuals -> nix.dev -> nixos.org" instead of "nix.dev -> manuals -> nixos.org" which feels more intuitive to me? At least using the "increasing public visibility" criterion, it should be the second because the manuals appear on nixos.org/learn.html directly and nix.dev is called "unofficial and opinionated" there.14:33:33
3 Nov 2022
@fricklerhandwerk:matrix.orgfricklerhandwerk

Hi Tobbe. That's for two reasons:

  1. nix.dev is for learning, the manuals for looking up facts. We expect new users to mostly learn, and experienced users to mostly look up facts. Also we can assume that most users are new.
  2. There is always some degree of wishful thinking involved, otherwise we could not implement any change at all. We would like to eventually make nix.dev official.
06:39:14
@fricklerhandwerk:matrix.orgfricklerhandwerk *

Hi Tobbe. That's for two reasons:

  1. nix.dev is for learning, the manuals for looking up facts. We expect new users to mostly learn, and experienced users to mostly look up facts. Also we can assume that most users are new.
  2. There is always some degree of wishful thinking involved, otherwise we could not implement any significant change at all. We would like to eventually make nix.dev official.
07:40:06
@joerg:thalheim.ioMic92fricklerhandwerk: I am going to skip this documentation meetup. Too tired...15:56:51
4 Nov 2022
@rapenne-s:tchncs.deSolène Rapenne (she/her)

Mic92 wiki pages to delete

did the wiki experienced a rollback? 🤔

16:20:02
@rapenne-s:tchncs.deSolène Rapenne (she/her) *

Mic92 wiki pages to delete if you can take the time for it 👍

did the wiki experienced a rollback? 🤔

16:20:16
@joerg:thalheim.ioMic92rapenne-s: I deleted them16:39:18
5 Nov 2022
@hjulle:matrix.orghjulle set a profile picture.04:09:43
@asymmetric:matrix.dapp.org.ukasymmetric changed their profile picture.16:20:38
8 Nov 2022
@alex:tunstall.xyzAlexIs there a quick link to access the Hydra manual like there is for the Nix/Nixpkgs/NixOS manuals? Currently, finding the latest version of it isn't easy.16:30:29
@yuki:backalley.clubYuki (they/them)Not as far as I'm aware16:29:55
@yuki:backalley.clubYuki (they/them)Google first result is the literal hydra build for the hydra manual.16:30:08
@fricklerhandwerk:matrix.orgfricklerhandwerkhttps://nixos.org/hydra/manual/ seems to redirect to the latest build22:39:46

Show newer messages


Back to Room ListRoom Version: 6