!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

438 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
1 Sep 2022
@sandro:supersandro.deSandro 🐧https://github.com/NixOS/nixpkgs/pull/18924110:12:46
@tpw_rules:matrix.orgtpw_rulesis there any reason to ever use the short hash?15:55:17
@tpw_rules:matrix.orgtpw_rulesin any git context?15:55:25
@raphi:tapesoftware.netraphiRedacted or Malformed Event16:02:59
2 Sep 2022
@jtojnar:matrix.orgJan Tojnarsometimes it is more convenient to type it manually than to copy it (e.g. when working on command line without mouse)08:58:58
@sandro:supersandro.deSandro 🐧
In reply to @tpw_rules:matrix.org
is there any reason to ever use the short hash?
if you only need it for 5 minutes, it can be convenient but for anything log lived it shouldn't be used
10:33:43
@tpw_rules:matrix.orgtpw_ruleslet me restate: is there any reason to record the short hash in a file in nixpkgs in any git context? i feel like the documentation calling out github specifically is short-sighted. presumably other git services do similar weird things. even in a comment you might not be able to look it up later12:44:52
@tpw_rules:matrix.orgtpw_rules * let me restate: is there any reason to record the short hash in a file in nixpkgs in any git context? i feel like the documentation calling out github specifically is short-sighted. presumably other git services do similar weird things. even if you say in a comment "since commit abcdef we X" that might become ambiguous later 12:45:29
@tpw_rules:matrix.orgtpw_rules * let me restate: is there any reason to record the short hash in a file contributed to nixpkgs in any git context? i feel like the documentation calling out github specifically is short-sighted. presumably other git services do similar weird things. even if you say in a comment "since commit abcdef we X" that might become ambiguous later 12:46:10
@sandro:supersandro.deSandro 🐧well, git diffs have short hashes by default but they are not resolved for applying 13:26:53
@sandro:supersandro.deSandro 🐧but it probably applies to most if not all other git hosting softwares13:27:57
@kity:kity.wtfproblems changed their display name from ash (it/its) 🏳️‍⚧️ to problems.14:09:39
3 Sep 2022
@alunduil:matrix.orgalunduil joined the room.17:37:37
8 Sep 2022
@infinisil:matrix.orginfinisilhttps://nixos.wiki/wiki/Nix_Language_Quirks16:02:57
@infinisil:matrix.orginfinisilhttps://github.com/orgs/NixOS/teams/documentation-team/members16:23:27
@pennae:matrix.eno.spacepennaeabent any other required changes we'd like to merge https://github.com/NixOS/nixpkgs/pull/189318 in a week. (will add a comment on the pr too.)16:29:32
@pennae:matrix.eno.spacepennae
In reply to @infinisil:matrix.org
https://nixos.wiki/wiki/Nix_Language_Quirks
still rather fond of quirks like let __sub = __add; in 1 - 2
16:46:18
9 Sep 2022
@cozypenguin:matrix.orgCarl Schierig joined the room.20:20:05
13 Sep 2022
@raphi:tapesoftware.netraphi changed their profile picture.06:58:30
@gianarb:matrix.orgGianluca Arbezzano joined the room.14:11:00
@gianarb:matrix.orgGianluca Arbezzano

I wrote this article on my blog after a few days of strugling learning a few new things (I am not that good with Nix yet). I am wondering if we can get something out of it for the netbooting wiki. For example:

  • Do we want to change it to use flake?
  • Should we add the nixos-rebuild vm-build to it?

Let me know and if you like the direction I am happy to attempt an improvement :)

14:12:59
@gianarb:matrix.orgGianluca Arbezzano *

I wrote this article (https://gianarb.it/blog/my-workflow-with-nixos) on my blog after a few days of strugling learning a few new things (I am not that good with Nix yet). I am wondering if we can get something out of it for the netbooting wiki. For example:

  • Do we want to change it to use flake?
  • Should we add the nixos-rebuild vm-build to it?

Let me know and if you like the direction I am happy to attempt an improvement :)

14:13:10
@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

Show newer messages


Back to Room ListRoom Version: 6