| 23 Sep 2024 |
 loudgolem | In reply to @fricklerhandwerk:matrix.org
Thanks for the pointer. Please open an issue on GitHub so we don't lose track of it seems there is one already by you, https://github.com/NixOS/nix/issues/7981 | 09:33:06 |
 fricklerhandwerk | Ah thanks, I didn't find it on a quick skim | 09:34:42 |
| loudgolem | what is the current ongoing documentation effort, I mean what is being worked on?
where can I follow it? | 09:39:22 |
| loudgolem | ok I found what has been done recently https://discourse.nixos.org/search?q=This%20Month%20in%20Nix%20Docs%20in%3Atitle%20order%3Alatest_topic | 09:49:36 |
| loudgolem | also https://github.com/orgs/NixOS/projects/15/views/1 | 14:09:44 |
|  elikoga joined the room. | 15:30:54 |
|  connor (burnt/out) (UTC-8) changed their display name from connor (he/him) (UTC-5) to connor (he/him) (UTC-7). | 17:57:39 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.org
what is the current ongoing documentation effort, I mean what is being worked on?
where can I follow it? It’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 |
| loudgolem | In reply to @fricklerhandwerk:matrix.org
It’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 I'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 |
| loudgolem | let me know if there is something similar already, I couldn't find it in my brief search | 20:39:45 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.org
I'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. In the Nixpkgs and NixOS manuals, internal references are already checked. You could run lychee impurely to check external links though | 20:40:55 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.org
I'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. * 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 |
| loudgolem | yes, external links in manuals is what I was thinking, also checking meta.homepage meta.changelog if possible for all packages | 20:42:12 |
| fricklerhandwerk | The Nix manual could need help with internal references though:
- https://github.com/NixOS/nix/issues/10313
- https://github.com/NixOS/nix/pull/11306
| 20:43:26 |
| loudgolem | oh, I could've searched for lychee in issues, didn't realise it. I will look at those. | 20:44:38 |
| loudgolem | also do you think "checking meta.homepage meta.changelog if possible for all packages" makes sense? | 20:45:52 |
| loudgolem | since hydra will build almost all nixpkgs so those packages will fail right? | 20:46:37 |
| fricklerhandwerk | In reply to @phanirithvij:matrix.org
also do you think "checking meta.homepage meta.changelog if possible for all packages" makes sense? in 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 |
| fricklerhandwerk | and it shouldn't be a blocker for anything | 20:47:29 |
| fricklerhandwerk | What we could and should do is run linkchecks on all of our domains: nixos.org, nix.dev, ... | 20:48:28 |
| fricklerhandwerk | * What we could and should do is unconditionally run linkchecks on all of our domains: nixos.org, nix.dev, ... | 20:48:35 |
| 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.org
What we could and should do is more thoroughly run linkchecks on all of our domains: nixos.org, nix.dev, ... 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 more than simply adding sheduled gha to all these repos? | 21:00:23 |
| loudgolem | In reply to @fricklerhandwerk:matrix.org
What we could and should do is more thoroughly run linkchecks on all of our domains: nixos.org, nix.dev, ... * 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.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 more than simply adding sheduled gha to all these repos? Sure. But adding checks is a fist step that's not wrong | 21:00:50 |
| fricklerhandwerk | In reply to @phanirithvij: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 more than simply adding sheduled gha to all these repos? * 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 |
