Nix Documentation | 419 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 87 Servers |
| Sender | Message | Time |
|---|---|---|
| 23 Sep 2024 | ||
| also https://github.com/orgs/NixOS/projects/15/views/1 | 14:09:44 | |
| 15:30:54 | ||
| 17:57:39 | ||
In reply to @phanirithvij:matrix.orgIt’s been a bit quiet around the team recently, and the project board is out of date. There are a few isolated efforts here and there, and I keep reviewing PRs. Any help is greatly appreciated - if you want to pick up or start something, we can supply all the information you need to get going | 18:59:37 | |
In reply to @fricklerhandwerk:matrix.orgI've added a broken link checker github workflow to nixos wiki infra recently and plan to do something similar to find broken/outdated links in nixpkgs as a maintainer script. | 20:38:42 | |
| let me know if there is something similar already, I couldn't find it in my brief search | 20:39:45 | |
In reply to @phanirithvij:matrix.orgIn the Nixpkgs and NixOS manuals, internal references are already checked. You could run lychee impurely to check external links though | 20:40:55 | |
In reply to @phanirithvij:matrix.org* In the Nixpkgs and NixOS manuals, internal references are already checked by the rendering engine. You could run lychee impurely to check external links though | 20:41:05 | |
yes, external links in manuals is what I was thinking, also checking meta.homepage meta.changelog if possible for all packages | 20:42:12 | |
| The Nix manual could need help with internal references though:
| 20:43:26 | |
oh, I could've searched for lychee in issues, didn't realise it. I will look at those. | 20:44:38 | |
| also do you think "checking meta.homepage meta.changelog if possible for all packages" makes sense? | 20:45:52 | |
| since hydra will build almost all nixpkgs so those packages will fail right? | 20:46:37 | |
In reply to @phanirithvij:matrix.orgin principle, but we have to be careful to rate limit that very tightly. it shouldn't run on every hydra job but more like once a month at most | 20:46:56 | |
| and it shouldn't be a blocker for anything | 20:47:29 | |
| What we could and should do is run linkchecks on all of our domains: nixos.org, nix.dev, ... | 20:48:28 | |
| * What we could and should do is unconditionally run linkchecks on all of our domains: nixos.org, nix.dev, ... | 20:48:35 | |
| * What we could and should do is more thoroughly run linkchecks on all of our domains: nixos.org, nix.dev, ... | 20:48:43 | |
| (but probably also not every single time) | 20:49:09 | |
| yes, scheduled github action (once/twice a month) makes sense, along with a maintainer script for running manually. | 20:55:11 | |
In reply to @fricklerhandwerk:matrix.orgnix.dev (incl nix manual), nixos-homepage, nix (+manual), nixpkgs (nixos, nixpkgs manuals), nixos-wiki-infra all seem to need the lychee checks. maybe need to think about more than simply adding sheduled gha to all these repos? | 21:00:23 | |
In reply to @fricklerhandwerk:matrix.org* nix.dev (incl nix manual), nixos-homepage, nix (+manual), nixpkgs (nixos, nixpkgs manuals), nixos-wiki-infra all seem to need the lychee checks. maybe need to think about it more than simply adding sheduled gha to all these repos? | 21:00:41 | |
In reply to @phanirithvij:matrix.orgSure. But adding checks is a fist step that's not wrong | 21:00:50 | |
In reply to @phanirithvij:matrix.org* Sure. But adding checks as a first step is not wrong, it won't make things worse | 21:01:09 | |
| (nix.dev has link checking and it regularly messes up builds because someone stops tolerating us hitting them) | 21:01:29 | |
| I don't think lychee check should be a blocker anywhere, it should just be a like warnings/report. | 21:03:53 | |
| * Sure. But adding checks as a first step is not wrong, it will prevent things from falling apart and gives us time to think | 21:03:56 | |
| * I don't think lychee check should be a blocker anywhere, it should just be like warnings/report. | 21:04:11 | |
| * Sure. But adding checks as a first step is not wrong, it will prevent things from falling apart while we're thinking | 21:04:21 | |
In reply to @fricklerhandwerk:matrix.orgok, linkcheck from sphinx. my experience with lychee with github urls even with github_token provided will still result in flaky 403 errors, I wonder how linkcheck is working fine | 21:11:42 | |