feat: markdownlint: Add a links checker and fix some links

[xlai89]

Add a links checker using lychee into test-markdownlint.sh

Some links are fixed as well.

Fixes #440.

Main reason to choose lychee over muffet:
easy to use. lychee can deal with files, path wildcards and urls, while muffet expects urls as input.

[xlai89]

Hi @purpleidea ,
should the following deprecated links just be removed? Didn't manage to update them.

[docs/on-the-web.md]:
✗ [404] https://www.youtube.com/watch?v=jB992Zb3nH0&html5=1 | Failed: Network error: Not Found
✗ [404] https://www.youtube.com/watch?v=MmpwOQAb_SE&html5=1 | Failed: Network error: Not Found
✗ [404] https://vimeo.com/191493409 | Failed: Network error: Not Found
✗ [ERR] https://roidelapluie.be/blog/2017/02/14/mgmt-augeas/ | Failed: Network error: error sending request for url (https://roidelapluie.be/blog/2017/02/14/mgmt-augeas/)
✗ [ERR] https://annex.debconf.org//debconf-share/debconf16/slides/15-next-generation-config-mgmt.pdf | Failed: Network error: error sending request for url (https://annex.debconf.org//debconf-share/debconf16/slides/15-next-generation-config-mgmt.pdf)

[purpleidea]

Awesome! One question, and also what do you think we need to do about the timeouts and other issues in the logs? I'll look at the broken links not included in your patch.

Also your commit message should be:

test: Add a links checker and fix some links

To pass...

[purpleidea]

Why is this change needed?

[xlai89]

After updating mdl to 0.13.0 locally, the test passes as well in my dev env. This change is not necessary and has been removed from the patch.

[purpleidea]

I am just uploading some fixed links, and I will submit a patch to git master with the fixes. After that is done, in theory rebasing your patch should be enough. Thanks again!

[purpleidea]

Should be ready for rebase.

[xlai89]

Thanks for the hint!
Rebase is done. Also corrected the commit message and removed the unnecessary changes.
Can you be more specific about "the timeouts and other issues in the logs" mentioned in an earlier comment?

[purpleidea]

Rebase is done.

Awesome running tests now.

Also corrected the commit message and removed the unnecessary changes.

Sweet.

Can you be more specific about "the timeouts and other issues in the logs" mentioned in an earlier comment?

Yes, sorry about my lack of clarity. In the previous build test: https://github.com/purpleidea/mgmt/actions/runs/8958628695/job/24604796138#step:6:178

I see some network timeout issues. Is that a concern? Let's see what this run does. Here's a screenshot:

It occured to me that GH actions might actually rate limit things. If so we might have to disable some stuff. We'll see.

[purpleidea]

It seems it might be following a non-link but pretending it's a link. Is there a way to disable that?
(And the formatting needs fixing to wrap at 80.)

[xlai89]

Sorry for the late reply.

It seems it might be following a non-link but pretending it's a link. Is there a way to disable that?

Links can be excluded by add them into .lycheeignore, which contains 2 links for the moment.

(And the formatting needs fixing to wrap at 80.)

If you mean output of the lychee command, I could change the format with the option --format but couldn't limit the length of errors. When it comes to the length of my codes, I somehow didn't find the spot exceeding 80.

[purpleidea]

Patch looks good. One quick Q. But otherwise should we merge?

[purpleidea]

Why do we want to exclude this URL?

[xlai89]

Ignoring the first url because it does not work, like in a previous build test.
Ignoring the second url because of possible rate limiting e.g. in this build test.
But this is just a suggestion and the second link can be removed from .lycheeignore.