docs: Check markdown files for bad links using linkinator

[rusackas]

SUMMARY

Adding a little CI magic to test markdown files for problem links using Linkinator. Hopefully this remedies some of the issues stemming from moving pages around.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

• Has associated issue:
• Required feature flags:
• Changes UI
• Includes DB Migration (follow approval process in SIP-59)
  • Migration is atomic, supports rollback & is backwards-compatible
  • Confirm DB migration upgrade and downgrade tested
  • Runtime estimates and downtime expectations provided
• Introduces new feature or API
• Removes existing feature or API

[rusackas]

@mistercrunch seems like the action isn't running :/

I'll investigate in the morning unless you see anything plainly obvious.

[mistercrunch]

visible here -> https://github.com/apache/superset/actions/runs/9027384874

[mistercrunch]

https://github.com/marketplace/actions/markdown-link-check

?

[rusackas]

I'll open another one with that other action. This one looked simpler when I opened it, but... I guess it's not so simple!

I opened an Infra ticket to see if there's a preferred practice for cases like this:
https://issues.apache.org/jira/issues/?filter=-2

[rusackas]

Actually, that other Action is also on a 3rd party repo, so that won't be any easier.

[mistercrunch]

It'd be good to know where the full complex rule lives behind this truncated one ->

[mistercrunch]

Actually the truncation in the screenshot above cuts right before fully pointing to https://github.com/gaurav-nelson/github-action-markdown-link-check

[rusackas]

Ok, opened a PR using the other action here: #28437

This other action, however, is in maintenance mode, pending some replacement with the author. It also doesn't support multiple file extensions in its config, so we have to run it twice. That's a bit silly, but hopefully it'll work.

[rusackas]

Linkinator has now been added to the ASF allow list... let's see if this is simpler/faster than the other PR :)

[rusackas]

Sorry for all the noise. A rebase went quite goofy...

I'll start chipping away at more of the failing links.