Documentation Automation for about.gitlab.com
Problem to solve
As time passes and new features come aboard, content in our marketing site and handbook become outdated or results in 404. Feature images are becoming outdated and are not showing the latest functionality.
Further details
Example of dead images on solutions page
Proposal
A deadlink scanner was implemented for only a new/updated changes to the site. (!8067 (merged))
Address Dead Links One suggestion is to have a scheduled pipeline to scan for dead links and open an MR for the line commit and committer.
Address Outdated Images on Marketing Pages Another scheduled pipeline to scan last image commits on marketing site and if the commit was >6 months old, create an MR and tag appropriate team to update images.
Other notes
There is an epic covering technical documentation automation that may have similar issues. docs.gitlab.com gitlab-org&221
There are concerns on build times and performance of processing all the pages. Engineer team may be able to weigh in on this