levi-leah / lcheck Goto Github PK

Typically, you generate a report, redirect it to a file, and process it afterwards.

For that, it would be useful if the command output summarized what it generates (repo name, checked version) at the beginning, and concluded the output with some basic stats, just like the LinkChecker tool used with -l . In particular , the link checked/mismatched link found would be useful.

Since lcheck builds all documents before checking links, it seems to be well-positioned to also discover links which work but use a wrong major version, most prominently RHEL 9 (Beta) docs pointing to RHEL 8 docs. By default, it is safe to assume that such a link is wrong so the testing procedure could be fairly basic.

We don't have to stop there. Another related and fairly frequent bug is that {ProductNumber} is not always used where it should. As a consequence, there are occurrences of "RHEL 8" in RHEL 9 docs. If possible (and reasonably easy to implement), make the versions configurable on the command line or via a config file.

EDIT: Come to think of it, maybe simply identifying links with the any wrong number relative to the source doc would be robust enough to cover multiple use cases (8 -> 9, 9 -> 8, 8 -> 7, etc.)

Thank you

In particular, we want to watch {PackageManagerCommand} and {ProductNumberLink} for now but there might be more variables later to check.

There might also be typos in the attrs (in the name or missing/doubled parenthesis) so some heuristics might be in order to have this robust enough. Overgenerating results is probably better than potentially missing some.

Thanks!