ckeditor / ckeditor4

The best enterprise-grade WYSIWYG editor. Fully customizable with countless features and plugins.
https://ckeditor.com/ckeditor-4
Other
5.8k stars 2.48k forks source link

Fix old links to API documentation in changelog #3522

Open Dumluregn opened 5 years ago

Dumluregn commented 5 years ago

Type of report

Docs

Provide a description of requested docs changes

Some old links in changelog pointing to docs are incorrect and lead to 404. Examples can be found e.g. in version 4.5.9 (ticket #13886). In this particular reason the problem is . instead of _ (link is https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR.style.html when it should be https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_style.html).

f1ames commented 5 years ago

Better solution would be to add redirects, since fixing changelog would fix only part of the problem - all changelog file copies downloaded/distributed before the fix will still not work (and changelog file is included in every CKEditor 4 build). Should be doable by adding redirects to docs Umberto config - https://github.com/ckeditor/ckeditor4-docs/blob/5cb9717ba254e7b09a7cf06ff93b15f3098171af/umberto.json#L454.

TBH, I think we should do both, so fix changelog links but also add redirects for any old links which still may be present in old changelog copies and other external places.