!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

364 Members
Discussion about documentation improvements around the Nix ecosystem87 Servers

Load older messages


SenderMessageTime
23 Jul 2024
@ezzobirbezziou:matrix.orgEzzobir Bezziou joined the room.08:22:40
24 Jul 2024
@redstone-menace:matrix.orgRedstone changed their display name from redstone-menace to Redstone.10:14:59
26 Jul 2024
@shivaraj:matrix.orgshivaraj-bh set a profile picture.06:40:20
@philiptaron:matrix.orgPhilip Taron (UTC-8)

Hey folks -- I'd like to make the NixOS manual and the Nixpkgs manual be exposed in pkgs as a normal package. I made some initial work in this draft PR https://github.com/NixOS/nixpkgs/pull/311459 and got positive feedback from Johannes Kirschbauer @hsjobeki. I'm planning on picking it up again today and driving for completion.

Any objections or redirections before I do that?>

16:59:40
@philiptaron:matrix.orgPhilip Taron (UTC-8) *

Hey folks -- I'd like to make the NixOS manual and the Nixpkgs manual be exposed in pkgs as a normal package. I made some initial work in this draft PR https://github.com/NixOS/nixpkgs/pull/311459 and got positive feedback from Johannes Kirschbauer @hsjobeki. I'm planning on picking it up again today and driving for completion.

Any objections or redirections before I do that?

16:59:42
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @philiptaron:matrix.org

Hey folks -- I'd like to make the NixOS manual and the Nixpkgs manual be exposed in pkgs as a normal package. I made some initial work in this draft PR https://github.com/NixOS/nixpkgs/pull/311459 and got positive feedback from Johannes Kirschbauer @hsjobeki. I'm planning on picking it up again today and driving for completion.

Any objections or redirections before I do that?

Great stuff, thanks a lot!
17:07:06
@sandro:supersandro.deSandro 🐧Will this trigger one rebuild for every PR touching modules in any way?17:07:55
@philiptaron:matrix.orgPhilip Taron (UTC-8)Only if the documentation changes, I think.17:10:16
@philiptaron:matrix.orgPhilip Taron (UTC-8) * Only if the documentation changes, I think. But I don't know.17:10:31
@philiptaron:matrix.orgPhilip Taron (UTC-8) fricklerhandwerk: regarding your comment, note that doc/default.nix and doc/shell.nix remain: the guts of how they're implemented move over. 17:11:14
@philiptaron:matrix.orgPhilip Taron (UTC-8)I think that's the way it ought to be.17:11:25
@sandro:supersandro.deSandro 🐧like nixos-install-tools and tests.nixos-functions.nixos-test already do17:11:45
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @philiptaron:matrix.org
fricklerhandwerk: regarding your comment, note that doc/default.nix and doc/shell.nix remain: the guts of how they're implemented move over.
I understand, and splitting that into two parts doesn't make much sense to me. I suggest not breaking locality
17:12:10
@philiptaron:matrix.orgPhilip Taron (UTC-8)Hmmm, I really liked how doc/ was now the actual documentation and there wasn't what I considered to be an awkward doc-support directory that wasn't documentation. But I'll take your feedback.17:14:31
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @philiptaron:matrix.org
Hmmm, I really liked how doc/ was now the actual documentation and there wasn't what I considered to be an awkward doc-support directory that wasn't documentation. But I'll take your feedback.
I understand, but arguably none of that content should actually live in there, and instead be right in or next to the code it's documenting
17:18:56
@fricklerhandwerk:matrix.orgfricklerhandwerkAnd also the glue code is hardly separable from the content structure that it helps produce17:19:24
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @philiptaron:matrix.org
Hmmm, I really liked how doc/ was now the actual documentation and there wasn't what I considered to be an awkward doc-support directory that wasn't documentation. But I'll take your feedback.
* I understand, but arguably most of that content should actually live in there, and instead be right in or next to the code it's documenting
17:19:39
@fricklerhandwerk:matrix.orgfricklerhandwerk * I understand, but arguably barely any of that content should actually live in there, and instead be right in or next to the code it's documenting 17:19:47
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobeki Yeah good work appreciate it.
I also agree to the locality point of fricklerhandwerk
17:22:47
@johannes.kirschbauer:scs.ems.hostJohannes Kirschbauer @hsjobekiBut also could be another PR17:22:59
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host
But also could be another PR
Sure, moving around lots of stuff is a completely different thing. I'm just saying let's leave everything there, but make the package more conventional
17:24:21
@philiptaron:matrix.orgPhilip Taron (UTC-8)
In reply to @fricklerhandwerk:matrix.org
And also the glue code is hardly separable from the content structure that it helps produce

I think I have the opposite intuition -- most of nixpkgs is code to orchestrate builds that is separated from the origin (i.e. upstream.) So when there's orchestration of builds within nixpkgs, my intuition is that separating it is normal and expected.

Since nixpkgs building on nixpkgs is a rare occurrence (mostly maintainers/, doc/, and nixos/) I doubt there's a pattern to it.

I'll follow your guidance, though.

17:26:42
@philiptaron:matrix.orgPhilip Taron (UTC-8)https://github.com/NixOS/nixpkgs/pull/311459 -- I think it's ready for review.20:52:24
28 Jul 2024
@matthewcroughan:defenestrate.itmatthewcroughan changed their display name from matthewcroughan to matthewcroughan - going to nix.camp.16:06:59
29 Jul 2024
@imincik:matrix.org@imincik:matrix.org left the room.10:01:46
6 Aug 2024
@likivik:kde.orglikivik joined the room.00:01:15
8 Aug 2024
@qyliss:fairydust.spaceAlyssa Ross set a profile picture.18:48:35
10 Aug 2024
@khaneliman:matrix.orgAustin Horstman changed their display name from Khaneliman to Austin Horstman.03:50:06
11 Aug 2024
@metello:matrix.orgtorarittehey, are there any active work going on the Nixpkgs manual's overrides and overlays sections? I only found https://github.com/NixOS/nixpkgs/pull/255132 (doc: Improve overlays section) on the documentation team's project board (https://github.com/orgs/NixOS/projects/15/views/1) 01:29:42
@infinisil:matrix.orginfinisil
In reply to @metello:matrix.org
hey, are there any active work going on the Nixpkgs manual's overrides and overlays sections? I only found https://github.com/NixOS/nixpkgs/pull/255132 (doc: Improve overlays section) on the documentation team's project board (https://github.com/orgs/NixOS/projects/15/views/1)
Related ongoing work by Johannes Kirschbauer @hsjobeki: https://github.com/NixOS/nixpkgs/pull/325479
15:24:25

Show newer messages


Back to Room ListRoom Version: 6