Add documentation error pages
Problem
Documentation URLs break occasionally because of structural updates and more.
For example, see !953 (merged), !967 (merged), !1001 (merged), !1051 (merged), !1058 (merged), etc.
This can be automatically fixed or proactively detected in a pipeline as described in #1162 (closed) or more specifically in #1162 (comment 234380665) using the vuepress-plugin-check-md
plugin.
However, even if when such broken URLs can be automatically detected and resolved, external sources will continue to use deprecated or broken links.
Proposal
At the moment, documentation error pages (Not found) rely on the hosting provider and the basic Not Found view added in VuePress.
Not Found page on meltano.com
|
Not Found page on localhost:8080
|
---|---|
Plan
- Override the error page on the hosting provider and use the custom Not Found view.
- Update the Not Found view and include some useful links.
Design
TBD
Benefits
This could improve content discoverability, decrease bounce rate, and more.