 | Nix Documentation | 365 Members |
| Discussion about documentation improvements around the Nix ecosystem | 85 Servers |
| Nix Documentation | 365 Members |
| Discussion about documentation improvements around the Nix ecosystem | 85 Servers |
| Sender | Message | Time |
|---|---|---|
| 23 Sep 2024 | ||
 fricklerhandwerk | * What we could and should do is more thoroughly run linkchecks on all of our domains: nixos.org, nix.dev, ... | 20:48:43 |
| fricklerhandwerk | (but probably also not every single time) | 20:49:09 |
 loudgolem | yes, scheduled github action (once/twice a month) makes sense, along with a maintainer script for running manually. | 20:55:11 |
| loudgolem | 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 |
| loudgolem | 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 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.orgSure. But adding checks is a fist step that's not wrong | 21:00:50 |
| fricklerhandwerk | 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 |
| fricklerhandwerk | (nix.dev has link checking and it regularly messes up builds because someone stops tolerating us hitting them) | 21:01:29 |
| loudgolem | I don't think lychee check should be a blocker anywhere, it should just be a like warnings/report. | 21:03:53 |
| fricklerhandwerk | * 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 |
| loudgolem | * I don't think lychee check should be a blocker anywhere, it should just be like warnings/report. | 21:04:11 |
| fricklerhandwerk | * 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 |
| loudgolem | 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 |
| loudgolem | also the redirect are good to know I guess, they can also be fixed. | 21:12:10 |
| loudgolem | In reply to @fricklerhandwerk:matrix.orgdo you mean checks like this sphinx/linkcheck? | 21:13:04 |
| loudgolem | does it work outside of sphinx? | 21:13:27 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.orgNo, nix.dev linkchecks are pure Sphinix | 21:14:58 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.org* No, nix.dev linkchecks are pure Sphinx | 21:15:15 |
| loudgolem | I think scheduled gha is the way to go for external links | 21:15:30 |
| loudgolem | am I right in assuming nix+nixpkgs+nixos manuals and wiki.nixos.org have a lot of overlap in people contributing? | 21:16:55 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.orgEh, not that much. There are like 2-3 regular contributors who have touched all of them, but otherwise these are mostly disjoint groups as far as I can tell | 21:19:06 |
| loudgolem | maybe a single gha which checks external links among all manuals + home-pages + wiki-dump could work? | 21:19:23 |
| loudgolem | wait, need to think about rate-limits as well. | 21:19:32 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.org* Eh, not that much. There are like 2-3 regular contributors who have touched all of them, but otherwise these are mostly disjoint groups as far as I can tell. I mean, it's complicated. Define "a lot". There's not that many people working on documentation overall. | 21:20:30 |
| fricklerhandwerk | * Eh, not that much. There are like 2-3 regular contributors who have touched all of them, but otherwise these are mostly disjoint groups as far as I can tell. I may be wrong. I mean, it's complicated. Define "a lot". There's not that many people working on documentation overall. | 21:20:53 |
| loudgolem | I found wiki to be easier to contribute to definitely | 21:21:24 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.orgThey all have very different update cycles, and running the checks in some other location from where the source is modified will just lead to people having to jump hoops. Had that with the Nix manual, please don't. | 21:21:56 |
| loudgolem | ok so gha per repo then, tested on corresponding stable manuals and sites and each repo can adjust the run frequency per its release cycle | 21:25:43 |
| loudgolem | this doesn't need an rfc does it? | 21:28:50 |
| loudgolem | I'm also interested in things like this https://discourse.nixos.org/t/nix-ecosystem-mind-map/28682/17
Another thing I'm interested in is to visualize/map nixpkgs health, i.e. how many packages are fresh, maintainer activity, most maintainted packages, packages without maintainers, long inactive maintainers etc. all of these clearly visible somewhere like nixpkgs.health. I see rfc 180 which adresses a few of these. | 21:37:17 |