!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

422 Members
Discussion about documentation improvements around the Nix ecosystem87 Servers

Load older messages


SenderMessageTime
25 Jun 2023
@pennae:matrix.eno.space@pennae:matrix.eno.spacelooking at the recent prs to nix.dev ... nixos-render-docs has a lot of features from myst, which sphinx uses 🤔23:55:08
27 Jun 2023
@zmitchell:matrix.org@zmitchell:matrix.org
In reply to @pennae:matrix.eno.space
looking at the recent prs to nix.dev ... nixos-render-docs has a lot of features from myst, which sphinx uses 🤔
What are you suggesting?
03:58:28
@zmitchell:matrix.org@zmitchell:matrix.orgI've pushed another commit to the contributing workflow (https://github.com/NixOS/nix.dev/pull/596), but there's still open questions about the git workflow. Using a separate branch for work is less than ideal, but I don't see another way around it unless we can mark pages as drafts and have Sphinx ignore them when publishing. Most static site generators can do this by default, but I'm not sure if Sphinx can without complaining about it during builds and breaking CI. There's probably a workaround, I haven't thought about it too hard.04:01:07
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @zmitchell:matrix.org
I've pushed another commit to the contributing workflow (https://github.com/NixOS/nix.dev/pull/596), but there's still open questions about the git workflow. Using a separate branch for work is less than ideal, but I don't see another way around it unless we can mark pages as drafts and have Sphinx ignore them when publishing. Most static site generators can do this by default, but I'm not sure if Sphinx can without complaining about it during builds and breaking CI. There's probably a workaround, I haven't thought about it too hard.
Silvan proposed dumping drafts into the maintainers directory where they are not rendered
06:27:54
@mightyiam:matrix.org@mightyiam:matrix.org joined the room.09:57:54
@pennae:matrix.eno.space@pennae:matrix.eno.space
In reply to @zmitchell:matrix.org
What are you suggesting?
not suggesting anything yet, but there may be a real possibility that nixos-render-docs could be used for nix.dev too. at least from a markup perspective, others (importantly: search!) would need a whole lot of work that is probably better spent doing other things
11:58:06
@zmitchell:matrix.org@zmitchell:matrix.org
In reply to @fricklerhandwerk:matrix.org
Silvan proposed dumping drafts into the maintainers directory where they are not rendered
That's fine with me, we just discussed something different at the time.
15:37:10
@zmitchell:matrix.org@zmitchell:matrix.org Is there any documentation explaining what's shown while you're building a package e.g. [1/32/39 built, 37 copied (26.4/26.5 MiB), 9.6 MiB DL]? 17:45:28
@zmitchell:matrix.org@zmitchell:matrix.org I would expect this to show up under the nix build command, but it shows up during other operations as well 17:45:59
@toonn:matrix.orgtoonn FWIW, I think it is current builds/finished builds/total builds. 18:17:59
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @zmitchell:matrix.org
Is there any documentation explaining what's shown while you're building a package e.g. [1/32/39 built, 37 copied (26.4/26.5 MiB), 9.6 MiB DL]?
this is one of my greatest sources of wonder, how can something as visible as this be undocumented 😂
20:24:42
@pennae:matrix.eno.space@pennae:matrix.eno.spacenix should really just steal nom in its entirety20:26:06
@toonn:matrix.orgtoonn TBF it is the UI for the experimental commands, I guess. 20:36:28
@olafklingt:matrix.org@olafklingt:matrix.org
In reply to @pennae:matrix.eno.space
nix should really just steal nom in its entirety
Whats nom?
20:58:39
@pennae:matrix.eno.space@pennae:matrix.eno.space nix-output-monitor. really nice visualizer, miles ahead of that one line you get out of nix 20:59:38
@alex:tunstall.xyzAlex
In reply to @pennae:matrix.eno.space
nix-output-monitor. really nice visualizer, miles ahead of that one line you get out of nix
You don't even get that one line without using the experimental nix3 commands :D
22:14:20
@figsoda:matrix.orgfigsoda
In reply to @zmitchell:matrix.org
Is there any documentation explaining what's shown while you're building a package e.g. [1/32/39 built, 37 copied (26.4/26.5 MiB), 9.6 MiB DL]?
https://github.com/NixOS/nix/issues/3352#issuecomment-584247583
22:51:42
28 Jun 2023
@joerg:thalheim.io@joerg:thalheim.ioI was thinking about pre-building nixos docs to save eval time when building nixos.01:55:28
@joerg:thalheim.io@joerg:thalheim.ioSo same thing as https://github.com/nix-community/nix-index-database but for docs.01:55:43
@pennae:matrix.eno.space@pennae:matrix.eno.space
In reply to @joerg:thalheim.io
I was thinking about pre-building nixos docs to save eval time when building nixos.
lazy options is exactly that
01:58:20
@pennae:matrix.eno.space@pennae:matrix.eno.spaceif you find more places where we can cache things then improvements are definitely welcome, but due to how nixos docs are built we think the next improvement will need flakes (or a similar mechanism for source caching)02:04:47
@zardian:matrix.org@zardian:matrix.org joined the room.06:32:32
@joerg:thalheim.io@joerg:thalheim.iopennae: so you are saying manual generation is already much faster? I haven't benchmarked in a while.12:36:56
@drupol:matrix.org@drupol:matrix.orgI just submitted a PR to fix the nixos manual 12:43:58
@drupol:matrix.org@drupol:matrix.orghttps://github.com/NixOS/nixos-homepage/pull/108512:44:01
@drupol:matrix.org@drupol:matrix.orgBut this doesn't have impact on speed 12:44:13
@drupol:matrix.org@drupol:matrix.orgJust than the produced html is wrong atm12:44:25
@drupol:matrix.org@drupol:matrix.org* Just that the produced html is wrong atm12:44:36
@drupol:matrix.org@drupol:matrix.orgThis PR actually https://github.com/NixOS/nixpkgs/pull/24032712:45:14
@pennae:matrix.eno.space@pennae:matrix.eno.space
In reply to @joerg:thalheim.io
pennae: so you are saying manual generation is already much faster? I haven't benchmarked in a while.
yeah, when we started out we cut about 40% of eval time off of it. can't remember how much the manual still costs, but it wasn't a substantial fraction or we would've probably gone there too.
(instead we went for the nix evaluator, and if that seems like the easier thing to do ...)
13:10:43

Show newer messages


Back to Room ListRoom Version: 6