!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

435 Members
Discussion about documentation improvements around the Nix ecosystem92 Servers

Load older messages


SenderMessageTime
13 Sep 2022
@fricklerhandwerk:matrix.orgfricklerhandwerk

Gianluca Arbezzano: Just took a look at https://nixos.wiki/wiki/Netboot - a great few first steps would be to split out the parts into separate files and add some explanation in between.

Your article appears to be a mostly guide with some story elements: it does not instruct the reader to build up the result step by step to help acquire the skill of making things like a tutorial would. Instead it just presents the absolutely necessary steps, assuming the reader will know what they are about. Also there are some personal things about how you got there.

Due to the large example it's not clear exactly which steps are required to do the job, and which are accidental to the example.The Wiki article could also use some context as introduction, such as linking to or explaining what netbooting is (for).

21:08:47
@fricklerhandwerk:matrix.orgfricklerhandwerk *

Gianluca Arbezzano: Thanks for getting in touch.

Just took a look at https://nixos.wiki/wiki/Netboot - a great few first steps would be to split out the parts into separate files and add some explanation in between.

Your article appears to be a mostly guide with some story elements: it does not instruct the reader to build up the result step by step to help acquire the skill of making things like a tutorial would. Instead it just presents the absolutely necessary steps, assuming the reader will know what they are about. Also there are some personal things about how you got there.

Assuming you would want to add contents from your article to the Wiki, I have the following suggestions:

  • Due to the large example it's not clear exactly which steps are required to do the job, and which are accidental to the example. Therefore it would be good to reduce it to the absolute minimum to showcase netbooting with NixOS.

  • The Wiki article could also use some context as introduction, such as linking to or explaining what netbooting is (for). It should absolutely not have other notes, as guides are supposed to be recipes for skilled users.

I would usually recommend to seize the opportunity and migrate such a guide to nix.dev to get it under proper version control, but to be honest I think it's a fairly niche use case and I wouldn't take time to review a PR on the topic due to different priorities. So please go wild on the Wiki article!

21:11:55
@andreas.schraegle:helsinki-systems.deAndreas Schrägle left the room.22:30:54
14 Sep 2022
@gianarb:matrix.orgGianluca Arbezzano Heello fricklerhandwerk ! I think I simplified my message. I contributed to other opensource projects in the past and it is not the first time for me writing tutorial or documentations. I wrote that article targeting my blog and what you said is correct, it does not apply to a wiki. I would like to know if we should evolve the Netbooting guide to Flake for example since I can get to a minimum example that does 100% what the current Wiki does but with Flake 07:08:56
@gianarb:matrix.orgGianluca Arbezzano * Heello fricklerhandwerk ! I think I simplified my message. I contributed to other opensource projects in the past and it is not the first time for me writing tutorial or documentations. I wrote that article targeting my blog and what you said is correct, it does not apply to a wiki. I would like to know if we should evolve the Netbooting guide to Flake for example since I can get to a minimum example that does 100% what the current Wiki does but with Flake or if we want to expand the current Wiki with a reference of with a chapter related to build-vm. I didn't realize that I could run a VM that way and I lost a few hours figuring out how to run QEMU properly (and I failed :P ) 07:10:35
@gianarb:matrix.orgGianluca Arbezzano * Heello fricklerhandwerk ! I think I simplified my message. I contributed to other opensource projects in the past and it is not the first time for me writing tutorial or documentations. I wrote that article targeting my blog and what you said is correct, it does not apply to a wiki. I would like to know if we should evolve the Netbooting guide to Flake for example since I can get to a minimum example that does 100% what the current Wiki does but with Flake or if we want to expand the current Wiki with a reference of with a chapter related to build-vm. I didn't realize that I could run a VM that way and I lost a few hours figuring out how to run QEMU properly (and I failed :P ). I feel good if I can avoid that pain to somebody else :D 07:10:54
@pennae:matrix.eno.spacepennae left the room.14:11:36
@qyliss:fairydust.spaceAlyssa Ross joined the room.15:47:05
15 Sep 2022
@drupol:matrix.orgPolI just created this repo to create UMLs of NixOS processes: https://github.com/drupol/nixos-processes07:50:41
@drupol:matrix.orgPolFeel free to contribute !07:50:44
@drupol:matrix.orgPol fricklerhandwerk: ^^ 08:08:39
@m_algery:leohoo.xyzm_algery joined the room.11:59:20
@m_algery:leohoo.xyzm_algery left the room.11:59:23
16 Sep 2022
@davidak:matrix.orgdavidakCan the Wiki use Markdown by default to be consistent with the other documentation and make it easy to move content to other documentation?11:27:08
@sandro:supersandro.deSandro 🐧its mediawiki so there is probably a plugin for that, that may or may not be good maintained 12:11:18
@infinisil:matrix.orginfinisilUnfortunately the wiki is a bit of a problem child: https://github.com/NixOS/nix.dev/issues/27919:30:50
18 Sep 2022
@FRidh:matrix.orgFRidh set a profile picture.17:20:54
19 Sep 2022
@cw:kernelpanic.cafeChinchilla Washington left the room.03:03:02
@fricklerhandwerk:matrix.orgfricklerhandwerk Gianluca Arbezzano: The Wiki is a community project, you're free to expand or amend it as you see fit. 🙂 21:52:23
20 Sep 2022
@gianarb:matrix.orgGianluca ArbezzanoSure things thanks!08:34:00
@drupol:matrix.orgPol fricklerhandwerk: Just created the PR: https://github.com/NixOS/nixpkgs/pull/192058 10:27:18
@gianarb:matrix.orgGianluca Arbezzano left the room.14:22:14
@gianarb:matrix.orgGianluca Arbezzano joined the room.14:22:41
22 Sep 2022
@ryantm:matrix.orgryantmI rebased https://github.com/NixOS/nixpkgs/pull/108063 and added all the new sections to it. The preview like usual is at http://ryantm.github.io/nixpkgs/04:23:58
@ryantm:matrix.orgryantmStill needs a lot of work to be serious, I feel.04:26:09
@Ericson2314:matrix.orgJohn Ericsonhttps://github.com/NixOS/nix/pull/7078 tiny little terminology thing I'd love the team's opinion on14:53:37
@raboof:matrix.orgraboof joined the room.15:23:02
@infinisil:matrix.orginfinisil John Ericson: https://github.com/NixOS/nix.dev/pull/267#issuecomment-1252815161 16:26:14
23 Sep 2022
@starf0x7:matrix.orgjurraca changed their display name from jeak to jurraca.15:53:25
24 Sep 2022
@rapenne-s:tchncs.deSolène Rapenne (she/her) I started to look at the Wiki to prune outdated information (using the Special:random page giving a random page), and I stumbled upon https://nixos.wiki/wiki/Packaging/Perl , I wonder if we should delete this page, I'm fine removing it because it doesn't seem to provide any good value And I'm curious to know why the nixpkgs manual url is https://ryantm.github.io/nixpkgs/languages-frameworks/perl/#ssec-perl-packaging :D 18:41:55

Show newer messages


Back to Room ListRoom Version: 6