!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

Load older messages


SenderMessageTime
23 Sep 2024
@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
@phanirithvij:matrix.orgloudgolemam I right in assuming nix+nixpkgs+nixos manuals and wiki.nixos.org have a lot of overlap in people contributing?21:16:55
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
am I right in assuming nix+nixpkgs+nixos manuals and wiki.nixos.org have a lot of overlap in people contributing?
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
21:19:06
@phanirithvij:matrix.orgloudgolemmaybe a single gha which checks external links among all manuals + home-pages + wiki-dump could work?21:19:23
@phanirithvij:matrix.orgloudgolemwait, need to think about rate-limits as well. 21:19:32
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
am I right in assuming nix+nixpkgs+nixos manuals and wiki.nixos.org have a lot of overlap in people contributing?
*

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:matrix.orgfricklerhandwerk *

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
@phanirithvij:matrix.orgloudgolemI found wiki to be easier to contribute to definitely21:21:24
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @phanirithvij:matrix.org
maybe a single gha which checks external links among all manuals + home-pages + wiki-dump could work?
They 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

Show newer messages


Back to Room ListRoom Version: 6