NO-JIRA: Hack&Hustle - markdown link checker script and report

[fsgreco]

As part of my Hack & Hustle exploration, I added a new contrib script to scan Markdown files for URL issues and write identified problems (404s, errors, redirects) to a CSV report. This improves the quality of documentation links.

Analysis / Root cause:
The idea originated while working on #16362; links inside Markdown guidelines can become deprecated, broken, or modified over time.

Solution description:
This script simply iterates through every external link inside a Markdown file and quickly checks via curl whether the link reports a status code other than 200.

It requires human supervision at the end in order to decide whether a redirect is acceptable or not, or to find the replacement link in case the old one is broken. Hence, the CSV artifact is useful for manual review, whether run on a CI or locally.

Reviewers and assignees:
Docs approver:
/assign @Leo6Leo

[openshift-ci-robot]

@fsgreco: This pull request explicitly references no jira issue.

Details

In response to this:

As part of my Hack & Hustle exploration, I added a new contrib script to scan Markdown files for URL issues and write identified problems (404s, errors, redirects) to a CSV report. This improves the quality of documentation links.

Analysis / Root cause:
The idea originated while working on #16362; links inside Markdown guidelines can become deprecated, broken, or modified over time.

Solution description:
This script simply iterates through every external link inside a Markdown file and quickly checks via curl whether the link reports a status code other than 200.

It requires human supervision at the end in order to decide whether a redirect is acceptable or not, or to find the replacement link in case the old one is broken. Hence, the CSV artifact is useful for manual review, whether run on a CI or locally.

Reviewers and assignees:
Docs approver:
/assign @Leo6Leo

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: fsgreco
Once this PR has been reviewed and has the lgtm label, please assign jhadvig for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment