!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

438 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
25 Aug 2022
@pennae:matrix.eno.spacepennaeprobably won't be too long before the conversion itself is done20:00:38
@a-kenji:matrix.orga-kenji
In reply to @pennae:matrix.eno.space
a-kenji: there's no single issue, just us going through the modules and slowly converting the docbook option descriptions to markdown as a first step. after that we'll have to find a renderer to replace the current xsltproc stack (a process that apparently got stuck, https://discourse.nixos.org/t/any-consensus-on-documentation-generation-tool-for-nixpkgs-manual/15550)
Thanks!
20:01:21
@pennae:matrix.eno.spacepennaewe're hoping to at least have all options converted to MD for the 22.11 release and to have some warning in place for docbook descriptions during a transitional period20:09:20
26 Aug 2022
@denna:matrix.orgolafI found one more book: https://scrive.github.io/nix-workshop/ it's published under https://creativecommons.org/licenses/by-sa/4.0/ 11:05:02
27 Aug 2022
@ehllie:matrix.orgEhllie joined the room.13:09:36
29 Aug 2022
@brianna.g:matrix.orgbrianna.g joined the room.07:04:12
30 Aug 2022
@jakehamilton:matrix.orgjakehamilton joined the room.01:03:35
@aruzeta:matrix.orgaru joined the room.14:41:22
@aruzeta:matrix.orgaru left the room.15:54:40
31 Aug 2022
@sandro:supersandro.deSandro 🐧Someone can give me a pointer where this https://github.com/NixOS/nixpkgs/pull/187797#discussion_r956789756 would fit into the doc?15:16:59
@jtojnar:matrix.orgJan Tojnar Sandro 🐧: I would put it to https://nixos.org/manual/nixpkgs/stable/#chap-contributing 15:22:23
@trofi:matrix.orgtrofiAnd maybe https://nixos.org/manual/nixpkgs/stable/#sec-patches. Even now it provides a questionable example.18:46:16
@denna:matrix.orgolaf
In reply to @sandro:supersandro.de
Someone can give me a pointer where this https://github.com/NixOS/nixpkgs/pull/187797#discussion_r956789756 would fit into the doc?
i havn't read into the discussion but also have a look at fricklerhandwerk 's vision that has some good ideas what to put not into the manuals but into the book/nix.dev https://github.com/NixOS/nix.dev/blob/1bdb9be8012c2f44ce44c23fd6046ddb87e3772f/CONTRIBUTING.md#vision
20:51:26
1 Sep 2022
@fricklerhandwerk:matrix.orgfricklerhandwerk Sandro 🐧: I agree with Jan Tojnar (contributing guide, note and motivation/explanation) and trofi (the patch stuff, note and link to contributing guide) and the PR author (fetchFromGitHub, note and link to contributing guide) 06:54:44
@jtojnar:matrix.orgJan Tojnar fricklerhandwerk: do you not have a write access to pills as a nixpkgs committer? 08:07:59
@jtojnar:matrix.orgJan TojnarI can merge the EPUB PR myself but would prefer a review first08:08:28
@jtojnar:matrix.orgJan Tojnar fricklerhandwerk: now we just need to merge https://github.com/NixOS/nixos-homepage/pull/776 09:27:56
@sandro:supersandro.deSandro 🐧its going into https://github.com/NixOS/nixpkgs/blob/master/doc/contributing/coding-conventions.chapter.md#fetching-sources-sec-sources09:59:32
@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

Show newer messages


Back to Room ListRoom Version: 6