!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

404 Members
Discussion about documentation improvements around the Nix ecosystem79 Servers

Load older messages


SenderMessageTime
14 Mar 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk

I'd also say that a condition to split anything into multiple pages is that

  • There will still be a single-page rendering as an alternative
  • All anchors are redirected at the client

We can't do better than partially relying on client-side redirects, but it works okay for the Nix manual. In fact, I'm not even sure why it even works, but an anchor like in https://nixos.org/manual/nix#chap-tuning-cores-and-jobs will correctly propagate from the server-side redirect to https://nixos.org/manual/nix/stable/ to the client-side redirect script.

Changing where the manuals are hosted should therefore not be an issue if done carefully.

14:07:43
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host
In my opinion, the root of our current issues stems from the overuse of anchor tags. This overreliance has led to regressions and breakages that we're now struggling to address. The longer we delay taking action, the more severe and complex these problems become, exacerbating the situation further.
It's not critical as long as we don't change existing anchors and don't move files around without putting redirects in place. Just an annoyance which will keep adding friction. But it can be systematically addressed with the required care. It's one of these "someone just has to do it" cases :)
14:14:51
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostYes we could build a client side redirect. This would solve the migration issue. But this means the client side redirect handler has to be installed into the potentially new root page of manual/nixpkgs/stable/14:20:06
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host
Yes we could build a client side redirect. This would solve the migration issue. But this means the client side redirect handler has to be installed into the potentially new root page of manual/nixpkgs/stable/
Absolutely
14:27:41
@danielsidhion:nixos.devdanielsidhionI think providing single-page + multi-page solutions isn't conflicting and satisfies more people and use cases, so it's definitely something that any multi-page solution should investigate at the very least14:58:21
@danielsidhion:nixos.devdanielsidhionIs the jitsi server for the meeting working?15:02:19
@danielsidhion:nixos.devdanielsidhion(it is!)15:03:11
@mjolnir:nixos.orgNixOS Moderation Botchanged room power levels.18:45:33
15 Mar 2024
@dustsucker:matrix.orgdustsucker joined the room.09:29:53
@efx:matrix.orgEli Flanagan I'd like to improve the documentation for buildNpmPackage. To me, this is the story of how do you package node.js applications or libraries in nix. I'm running into a number of pitfalls and would like to have the languages section note these.
Before I go submitting changes, are there maintainers I should check in with? Or a particular guide to follow?
14:30:10
@danielsidhion:nixos.devdanielsidhion
In reply to @efx:matrix.org
I'd like to improve the documentation for buildNpmPackage. To me, this is the story of how do you package node.js applications or libraries in nix. I'm running into a number of pitfalls and would like to have the languages section note these.
Before I go submitting changes, are there maintainers I should check in with? Or a particular guide to follow?
Hey, thanks for being willing to improve the docs! There are codeowners for the javascript docs here, so I think they'll automatically get added to the PR once you make it: https://github.com/NixOS/nixpkgs/blob/master/.github/CODEOWNERS#L338
We have some docs conventions here: https://github.com/NixOS/nixpkgs/blob/master/doc/README.md#documentation-conventions
Not all the content is following those conventions yet, they are somewhat recent because we didn't have any written conventions until some months ago. I'm doing the work of making the nixpkgs manual more consistent with that.
I'd appreciate if you could try to follow those conventions as best as you can when making changes. I'll review your PR as well (just make sure it starts with "doc:" and I'll pick it up on my queue)
15:50:49
@danielsidhion:nixos.devdanielsidhion(also read that whole README doc I linked, it's very helpful)15:51:50
@efx:matrix.orgEli Flanagan most certainly. I love words so enjoy it! Thank you for the detailed info danielsidhion. I'll note to follow those conventions. 16:13:53
@efx:matrix.orgEli FlanaganI just created a GitHub account and seem to be unable to fork NixOS/nixpkgs. I'll work on the patch separately and may need some assistance getting the bytes into NixOS/nixpkgs.17:29:33
@efx:matrix.orgEli FlanaganI'll try git-send-mail patch approach per https://discourse.nixos.org/t/about-the-patches-category/477.17:31:37
@danielsidhion:nixos.devdanielsidhion
In reply to @efx:matrix.org
I just created a GitHub account and seem to be unable to fork NixOS/nixpkgs. I'll work on the patch separately and may need some assistance getting the bytes into NixOS/nixpkgs.
What URL are you using to try to fork? What error are you getting?
17:53:05
@efx:matrix.orgEli FlanaganUsing GItHub web UI from Linux. Tried Firefox and Brave. GitHub's web UI displays correctly but simply redirects to NixOS/nixpkgs17:53:51
@efx:matrix.orgEli Flanagani'm going to try to manually import a recent clone of nixpkgs and push to my profile17:54:12
@efx:matrix.orgEli FlanaganIt looks like I can start an "import" https://github.com/NixOS/nixpkgs into my private profile as a new repository. Though I'm curious if some kind of locking behavior is at play upstream.17:57:07
@danielsidhion:nixos.devdanielsidhion Oh sorry I misinterpreted what you said. Can you try forking with the github cli? gh repo fork NixOS/nixpkgs 17:58:39
@efx:matrix.orgEli Flanagan huh, looks like something is up: failed to fork: HTTP 403: You cannot fork this repository at this time (https://api.github.com/repos/NixOS/nixpkgs/forks) 18:06:16
@efx:matrix.orgEli FlanaganI also cannot fork someone's fork. I'm betting this is specific to the unique fact I just created this GitHub account. Thus, I'll wait till next week to try.18:13:36
@danielsidhion:nixos.devdanielsidhionThat could be it. Could also try contacting their support to see what's going on, I couldn't find anything on their website about new account limitations18:15:18
@efx:matrix.orgEli Flanaganhonestly have wandered too far down this rabbit hole. This is a patch for my PR whenever I can: https://gist.github.com/eli0f/f461a00a6746609b6bcf07eee68091f118:16:11
@danielsidhion:nixos.devdanielsidhionThat link gives me a 404 page18:16:55
@efx:matrix.orgEli Flanaganeek, i'm using my SourceHut account. I marked the Gist as public but looks like I don't exist yet :)18:19:08
@efx:matrix.orgEli Flanaganhttps://paste.sr.ht/~efx/7ff9532c1b8509e3482e990e5a07813cba7ee48718:20:33
@infinisil:matrix.orginfinisil We welcome Johannes Kirschbauer @hsjobeki, author of the accepted RFC 145 and https://noogle.dev/, to the docs team! 🚀 19:42:34
@infinisil:matrix.orginfinisilHomepage PR: https://github.com/NixOS/nixos-homepage/pull/135019:42:58
@grahamc:nixos.org@grahamc:nixos.org joined the room.21:48:35

Show newer messages


Back to Room ListRoom Version: 6