Doc: Automate broken link and broken image checks and notifications

[john-thomas-dotcms]

There are a number of broken links and broken images in our documentation that need to be corrected, and additional broken links/images get added over time without any way for us to easily identify and fix these problems.

We need an automated way to:

1. Find and notify us of all existing broken links and images.
2. Automatically identify broken links and images when documentation is updated, and prompt the user to fix those problems.

Note:

• Our Link Checker workflow sub-action does not work to prevent invalid links, since it flags some perfectly valid links as broken.
  • Specifically, it flags a link that just contains the URL of the doc (without /docs/latest in front of it) as invalid - even though that's a valid link.
  • And since we intentionally create links to other docs this way (without the /doc/latest prefix) - to ensure they'll continue to work even if we move the docs - it means that just about all docs will fail to save if we enable the Link Checker sub-action.
• So we need another way to do these checks.

Possible Solutions:

1. Create a Custom Field which uses a 3rd party tool to scan for broken links.
2. Integrate a 3rd party tool to scan for broken links when the content is checked in.
3. Ignore broken links on check-in, but have an automated tool to scan for links periodically, and send us a notification separately (like via email).

[stale]

This issue has been automatically marked as stale because it has not had activity within the past 90 days. It will be closed in 30 days no further activity occurs. Thank you.