!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

381 Members
This is the official channel for documentation in the Nix ecosystem. The documentation team meets here. More information: https://nixos.org/community/teams/documentation Video conference: https://jitsi.lassul.us/nix-documentation Meeting notes scratch pad: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA Past meeting notes: https://discourse.nixos.org/search?q=documentation%20team%20meeting%20order%3Alatest 73 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
23 Sep 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk
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
@phanirithvij:matrix.orgloudgolem 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:matrix.orgfricklerhandwerk

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
@phanirithvij:matrix.orgloudgolem oh, I could've searched for lychee in issues, didn't realise it. I will look at those. 20:44:38
@phanirithvij:matrix.orgloudgolemalso do you think "checking meta.homepage meta.changelog if possible for all packages" makes sense?20:45:52
@phanirithvij:matrix.orgloudgolemsince hydra will build almost all nixpkgs so those packages will fail right?20:46:37
@fricklerhandwerk:matrix.orgfricklerhandwerk
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:matrix.orgfricklerhandwerkand it shouldn't be a blocker for anything20:47:29
@fricklerhandwerk:matrix.orgfricklerhandwerkWhat we could and should do is run linkchecks on all of our domains: nixos.org, nix.dev, ...20:48:28
@fricklerhandwerk:matrix.orgfricklerhandwerk * What we could and should do is unconditionally run linkchecks on all of our domains: nixos.org, nix.dev, ...20:48:35
@fricklerhandwerk:matrix.orgfricklerhandwerk * What we could and should do is more thoroughly run linkchecks on all of our domains: nixos.org, nix.dev, ...20:48:43
@fricklerhandwerk:matrix.orgfricklerhandwerk(but probably also not every single time)20:49:09
@phanirithvij:matrix.orgloudgolemyes, scheduled github action (once/twice a month) makes sense, along with a maintainer script for running manually.20:55:11
@phanirithvij:matrix.orgloudgolem
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
@phanirithvij:matrix.orgloudgolem
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:matrix.orgfricklerhandwerk
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:matrix.orgfricklerhandwerk
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:matrix.orgfricklerhandwerk(nix.dev has link checking and it regularly messes up builds because someone stops tolerating us hitting them)21:01:29
@phanirithvij:matrix.orgloudgolemI don't think lychee check should be a blocker anywhere, it should just be a like warnings/report.21:03:53
@fricklerhandwerk:matrix.orgfricklerhandwerk * 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
@phanirithvij:matrix.orgloudgolem * I don't think lychee check should be a blocker anywhere, it should just be like warnings/report.21:04:11
@fricklerhandwerk:matrix.orgfricklerhandwerk * 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
@phanirithvij:matrix.orgloudgolem
In reply to @fricklerhandwerk:matrix.org
(nix.dev has link checking and it regularly messes up builds because someone stops tolerating us hitting them)
ok, 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
@phanirithvij:matrix.orgloudgolem also the redirect are good to know I guess, they can also be fixed. 21:12:10
@phanirithvij:matrix.orgloudgolem
In reply to @fricklerhandwerk:matrix.org
Sure. But adding checks as a first step is not wrong, it will prevent things from falling apart while we're thinking
do you mean checks like this sphinx/linkcheck?
21:13:04
@phanirithvij:matrix.orgloudgolemdoes it work outside of sphinx?21:13:27
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
does it work outside of sphinx?
No, nix.dev linkchecks are pure Sphinix
21:14:58
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
does it work outside of sphinx?
* No, nix.dev linkchecks are pure Sphinx
21:15:15
@phanirithvij:matrix.orgloudgolemI think scheduled gha is the way to go for external links21:15:30

Show newer messages


Back to Room ListRoom Version: 6