Check for broken links
(Shamelessly copied from https://gitlab.com/gitlab-org/gitlab-ce/issues/51696)
Problem to solve
Check for broken links, both internal and external
Further details
- 404s are bad UX; we should check the docs to assure we don't have them
- The recent change to use the
#led to broken links, as noted by the community on Twitter and LinkedIn - There were some broken links that went unnoticed: https://gitlab.com/gitlab-org/design.gitlab.com/merge_requests/165
Proposal
Implement a broken link checker, preferably in a job (not allowed to fail) that runs with the entire pipeline. As inspiration, checkout how GitLab Docs implemented their external link checker: https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/360