!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

415 Members
Discussion about documentation improvements around the Nix ecosystem84 Servers

Load older messages


SenderMessageTime
4 Aug 2023
@infinisil:matrix.orginfinisilGoogle Calendar said it would only send an update to the one new email i added to the guest list 🙃08:05:35
@asymmetric:matrix.dapp.org.ukasymmetricI think hiding the guest list might help? At least that’s what another calendar admin told me09:42:27
@infinisil:matrix.orginfinisilAh that sounds like a good idea10:12:00
@nonuke:matrix.orgnonuke joined the room.20:14:42
6 Aug 2023
@spacekookie:fairydust.spacekookie changed their profile picture.16:15:31
7 Aug 2023
@i97henka:matrix.orghenrik-chHi all - I will be on summer holidays - back again in the meetings on August 24th.09:30:39
@ncfavier:matrix.orgnf changed their profile picture.09:41:21
@asymmetric:matrix.dapp.org.ukasymmetricWon’t make it today13:42:07
8 Aug 2023
@pennae:matrix.eno.space@pennae:matrix.eno.space left the room.20:19:08
9 Aug 2023
@osslate:fsfe.orgosslate joined the room.16:01:43
@osslate:fsfe.orgosslateHi! I'm a technical writer by trade and I'd love to really help out with end-user Nix docs. For me, there's been a real problem with documentation resources accessible to people like me who are totally new to the paradigm Nix offers, and I'd like to play whatever part I can to improve them. I'm relatively skilled in docs structure, ensuring things are simple for the audience, and politely pestering people for technical info :)16:08:15
@osslate:fsfe.orgosslateWell, maybe not totally new at this stage... but new enough where things are still confusing!16:09:13
@penguincoder:matrix.wolfie.pw@penguincoder:matrix.wolfie.pwI sat in on one of the doc team's weekly meetings and they were reviewing a guide or outline for someone to come and write a longer form document.16:41:25
@penguincoder:matrix.wolfie.pw@penguincoder:matrix.wolfie.pwhttps://github.com/NixOS/nix.dev/tree/master/maintainers/working_groups/learning_journey/tutorial-outlines16:44:07
@proofconstruction:matrix.orgproofconstructionWelcome! If you can make it to the docs team meeting tomorrow, we could always use extra help! Here's the calendar: https://calendar.google.com/calendar/u/0/embed?src=b9o52fobqjak8oq8lfkhg3t0qg@group.calendar.google.com&pli=116:58:39
@osslate:fsfe.orgosslateSweet! I'll take a look at this tomorrow17:58:34
@osslate:fsfe.orgosslateFantastic :) looks like a good time for me, I'll be there!17:59:22
10 Aug 2023
@osslate:fsfe.orgosslateis nix.dev versioned somehow, to correspond with nixos/nixpkgs channels?11:10:50
@osslate:fsfe.orgosslateThis was a consideration I had in writing my own books/docs. Antora seemed like the best toolchain to achieve proper versioning and a toggle to switch, but I decided against it for my personal project as parsing Asciidoc to write automated codeblock testing infra is a pain11:13:15
@osslate:fsfe.orgosslateexample: Fedora documentation (Antora based) with a version toggle on the bottom left: https://docs.fedoraproject.org/en-US/fedora/latest/ There appears to be some Sphinx plugins laying around that do something similar, though I haven't tried them myself11:20:54
@infinisil:matrix.orginfinisil osslate: It is not, but I'd be in favor of having that, though because nix.dev can contain content relating to both Nix, Nixpkgs and possibly more, it should maybe somehow expose the versions of all of these orthogonally 11:22:21
@infinisil:matrix.orginfinisilNot sure how that should work though, haven't given it a lot of thought11:22:31
@osslate:fsfe.orgosslateHmmm that's true. It could get messy without proper thought11:23:20
@osslate:fsfe.orgosslateIf there's a soup of different versions of different components with content that combines them all, my first reaction would be to version the docs independently... but that introduces its own complexity problems and another layer of versioning 11:24:19
@infinisil:matrix.orginfinisilThis closely relates to the idea of writing all documentation close to the source, so in Nixpkgs or Nix directly, and nix.dev just collecting all the docs together from all the different repos and rendering them together. Then versioning would become easier because it's clear where a tutorial comes from11:24:39
@osslate:fsfe.orgosslateOh that's an interesting idea!11:27:58
@osslate:fsfe.orgosslate So some custom-built tooling would git fetch nixpkgs and generate a static website of content taken from there? 11:29:52
@infinisil:matrix.orginfinisil osslate: Something like that yeah, for reproducibility it should probably be some JSON lockfile with hashes read by Nix. 11:39:06
@osslate:fsfe.orgosslatenice! Sounds like a fun project :)11:44:57
@osslate:fsfe.orgosslateThinking from a new contributor's POV, my only concern would be barrier to entry depending on how its implemented. Drive-by contributions for docs can be very valuable, and if docs are in a non-traditional docs file structure that requires an amount of nixpkgs knowledge to locate, or potentially breaks the workflow many editors have for following links to other parts of the documentation from one source file, that might work against attracting people to dive in12:00:36

Show newer messages


Back to Room ListRoom Version: 6