!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

380 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 72 Servers

Load older messages


SenderMessageTime
22 Mar 2024
@jade_:matrix.org@jade_:matrix.org our install guide is terrible last i looked. it might have got better in the mean time though 07:06:37
@jade_:matrix.org@jade_:matrix.org i think such patches might be gleefully accepted in the docs? 07:06:58
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @jade_:matrix.org
i think such patches might be gleefully accepted in the docs?
Yes, if there's someone available to accept them. Help greatly appreciated.
08:58:05
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @ibizaman:matrix.org
hi 👋 I had an idea, what do you all think about "translating" the Archlinux install wiki to NixOS? Would be called something like "Arch Install Guide for NixOS". Essentially https://wiki.archlinux.org/title/Installation_guide but with all commands and instructions replaced by their NixOS equivalent? I think it's a good idea because I always found the Arch wiki pretty complete. I don't have a timeline to work on this but was already wondering if ppl found this to be a good idea.
We had a similar questions about a year ago, and I think there's no doubt that NixOS installation instructions are much behind Arch on many levels. Back then the main concern was: Sure, please port whatever, but who's gonna maintain it? That's the main difference between Nix* documentation and the Arch wiki: They have multiple highly active maintainers, and the docs team right now barely managed to extend its reach to the Nixpkgs manual. If you want to take responsibility for a chunk of NixOS documentation, please go ahead!
09:00:07
@olafklingt:matrix.org@olafklingt:matrix.org
In reply to @ibizaman:matrix.org
hi 👋 I had an idea, what do you all think about "translating" the Archlinux install wiki to NixOS? Would be called something like "Arch Install Guide for NixOS". Essentially https://wiki.archlinux.org/title/Installation_guide but with all commands and instructions replaced by their NixOS equivalent? I think it's a good idea because I always found the Arch wiki pretty complete. I don't have a timeline to work on this but was already wondering if ppl found this to be a good idea.
A agree that a good installation guide is the most important missing bit in nixos documentation. So every step into that direction is great. Please don't feel scared away by maintainance, that should not be a problem.
09:55:33
@ibizaman:matrix.orgibizaman Awesome, I’m glad for the positive feedback! 😊 What takes me a long time usually when writing is figuring out all the ideas and how they should fit in what order. I’m hoping that time will be reduced drastically by copying another great example which served me well a bunch of times already. 14:22:21
@efx:matrix.orgEli Flanagan danielsidhion: howdy! here is that docs cleanup PR I mentioned last week but couldn't submit: https://github.com/NixOS/nixpkgs/pull/298127
Turns out, one cannot sign up for a GitHub profile using aliased emails for initial configuration. I then tried with a work email, managed by Microsoft Office 365, and it they believed I am human.
18:16:29
@danielsidhion:nixos.devdanielsidhionThank you! Glad you figured out the issue with GitHub!21:37:10
@savanni:luminescent-dreams.com@savanni:luminescent-dreams.com left the room.21:45:06
23 Mar 2024
@federicodschonborn:matrix.org@federicodschonborn:matrix.org joined the room.00:37:56
24 Mar 2024
@dmills27:matrix.orgDominic MillsHere's my first draft for the Google Season of Docs proposal: https://github.com/DMills27/Nix-Google-Season-of-Docs. I'm continuously working on it. Any criticisms/feedback is welcomed!14:35:00
@roberthensing:matrix.orgRobert Hensing (roberth) Just wrote a testers helper to check links, if you're interested: https://github.com/NixOS/nixpkgs/pull/298665 15:52:38
@dmills27:matrix.orgDominic Mills * Here's my first draft for the Google Season of Docs proposal: https://github.com/DMills27/Nix-Google-Season-of-Docs. I'm continuously working on it. Any criticisms/feedback are welcomed!17:15:34
26 Mar 2024
@cblacktech:matrix.orgcblacktech joined the room.02:02:59
28 Mar 2024
@janne.hess:helsinki-systems.de@janne.hess:helsinki-systems.de joined the room.09:13:17
@pennae:matrix.eno.space@pennae:matrix.eno.space infinisil: reminder that you said you'd review a pr that removes the deprecated docbook support bits from the manual machinery 13:45:43
@fricklerhandwerk:matrix.orgfricklerhandwerk I’ll be in today again. danielsidhion has a write up for how to proceed with the Nixpkgs manual. We also should sync on Google Season of Docs. And whatever else is going on. 14:01:00
@infinisil:matrix.orginfinisil pennae: Ah yeah thanks for the reminder, it's in my notifications backlog, just didn't get to it yet. We might be able to review/merge it in the docs team meeting today, I'll put it on the agenda :) 14:14:57
@danielsidhion:nixos.devdanielsidhion fricklerhandwerk: infinisil Dominic Mills I made after-the-fact notes for the meeting today based on what I remembered, can you check if I missed anything? https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA?edit 20:59:08
@fricklerhandwerk:matrix.orgfricklerhandwerk danielsidhion: posted 21:35:24
@pennae:matrix.eno.space@pennae:matrix.eno.space

https://ethercalc.net/dc4vcnnl8zv0
people.
danielsidhion/fricklerhandwerk.

Does it support GitHub-flavored markdown? [nrd:] If we implement it
Can we render it to multiple pages? [nrd:] If we implement it
How can someone navigate the rendered docs? [nrd:] Single-page output with only immediate children visible on each section

we are increasingly concerned that people don't fucking read what we say. gfm is supported (the manual uses gfm tables!), multipage rendering is in use right now, tocgen is configurable.

infinisil asked as to come back to answer questions regarding the tooling, we've yet to hear one. should we just fucking leave again?

22:49:06
29 Mar 2024
@sebtm:lodere.esSebTM joined the room.04:23:53
@shalokshalom:kde.org@shalokshalom:kde.org joined the room.05:59:53
@shalokshalom:kde.org@shalokshalom:kde.orgI dont find the Wiki 2 channel anymore06:01:58
@shalokshalom:kde.org@shalokshalom:kde.orgAh, they renamed it 06:57:43
@shalokshalom:kde.org@shalokshalom:kde.org#wiki:nixos.org06:58:00
@danielsidhion:nixos.devdanielsidhion
In reply to @pennae:matrix.eno.space

https://ethercalc.net/dc4vcnnl8zv0
people.
danielsidhion/fricklerhandwerk.

Does it support GitHub-flavored markdown? [nrd:] If we implement it
Can we render it to multiple pages? [nrd:] If we implement it
How can someone navigate the rendered docs? [nrd:] Single-page output with only immediate children visible on each section

we are increasingly concerned that people don't fucking read what we say. gfm is supported (the manual uses gfm tables!), multipage rendering is in use right now, tocgen is configurable.

infinisil asked as to come back to answer questions regarding the tooling, we've yet to hear one. should we just fucking leave again?

gfm is supported (the manual uses gfm tables!)

gfm tables isn't the complete set of gfm, and from what I saw the current code doesn't support the full set (more importantly, doesn't support the github note/tip/warning box style).

multipage rendering is in use right now

The manuals aren't rendered in multiple pages and we have already established that it's not about just toggling a switch. If you render the manual in multiple pages, links break. It requires more effort than just a switch.
When I say multipage, I say the way that we expect chapers and sections to be in their own pages.

tocgen is configurable

It's already understood that we can change nrd's implementation the way we see fit, but for that particular line what matters is what the tool currently does

07:00:20
@danielsidhion:nixos.devdanielsidhionThat spreadsheet is being done in decision-matrix style following this rich hickey talk: https://www.youtube.com/watch?v=c5QF2HjHLSE The objective is to be factual in each cell while filling it. I think the current text in the cells reflect the current facts, but I can make mistakes. Please point them out (and thank you for caring enough to read through it!). I still think the cells you called out are factual07:03:17
@shalokshalom:kde.org@shalokshalom:kde.orgAh, a Hickey video I dont know yet ^^07:04:09
@danielsidhion:nixos.devdanielsidhion

infinisil asked as to come back to answer questions regarding the tooling, we've yet to hear one

As for this, I wanted to have that spreadsheet filled out before engaging in review, and then in its discussion, where questions and discussion about the tooling would be most important (and having the fresh discussion would be helpful IMO). I haven't had enough time to dedicate lately to filling out the sheet. It's something that will get done eventually as I put more effort in.

07:07:41

Show newer messages


Back to Room ListRoom Version: 6