Ckeditor5: Invalid links in documentation

Created on 30 Nov 2018 · 3Comments · Source: ckeditor/ckeditor5

Is this a bug report or feature request? (choose one)

Other - docuementation erros

📋 Steps to reproduce

New validator exposed invalid links in documentation, part of them exists in JSDoc, other part directly in markdown files. Case related to links with Collection#bindTo is reported here (https://github.com/ckeditor/ckeditor5-utils/issues/258) as it's result of different issue. Issues in most cases are related to wrong usage of hash fragment of url.

Error: Invalid internal links in /ckeditor5/11.1.1/api/engine.html:
  * '../framework/guides/architecture/intro.html#editing-engine' - editing engine&#x2019;s architecture
Error: Invalid internal links in /ckeditor5/11.1.1/api/module_editor-decoupled_decouplededitor-DecoupledEditor.html:
  * '../builds/guides/overview.html#decoupled-editor' - decoupled editor
Error: Invalid internal links in /ckeditor5/11.1.1/api/module_editor-decoupled_decouplededitor.html:
  * '../builds/guides/overview.html#decoupled-editor' - decoupled editor
Error: Invalid internal links in /ckeditor5/11.1.1/api/module_ui_viewcollection-ViewCollection.html:
  * 'module_utils_collection-Collection.html#bindTo' - Collection#bindTo
  * 'module_utils_collection-Collection.html#bindTo' - Collection#bindTo
Error: Invalid internal links in /ckeditor5/11.1.1/api/module_utils_collection-Collection.html:
  * 'module_utils_collection-Collection.html#bindTo' - Collection#bindTo
  * 'module_utils_collection-Collection.html#bindTo' - Collection#bindTo
Error: Invalid internal links in /ckeditor5/11.1.1/api/ui.html:
  * '../framework/guides/architecture/intro.html#ui-library' - UI library&#x2019;s architecture
Error: Invalid internal links in /ckeditor5/11.1.1/builds/guides/faq.html:
  * 'integration/frameworks/overview.html#official-integrations' - &#x201C;Official integrations&#x201D;
Error: Invalid internal links in /ckeditor5/11.1.1/builds/guides/integration/frameworks/overview.html:
  * '#official-rich-text-editor-integrations' - official integration
Error: Invalid internal links in /ckeditor5/11.1.1/builds/guides/integration/frameworks/react.html:
  * '#integrating-ckeditor-5-from-source' - CKEditor 5 built from source
  * '#integrating-ckeditor-5-from-source' - Integrating CKEditor 5 from source
  * '#changes-required-in-webpacks-production-config' - here
Error: Invalid internal links in /ckeditor5/11.1.1/builds/guides/migrate.html:
  * '../../framework/guides/architecture/intro.html#keystroke-handler' - Keystrokes and focus management
Error: Invalid internal links in /ckeditor5/11.1.1/builds/guides/support/browser-compatibility.html:
  * '#notes' - notes below
Error: Invalid internal links in /ckeditor5/11.1.1/builds/guides/whats-new.html:
  * '../../assets/img/letters-collab.jpg' -
Error: Invalid internal links in /ckeditor5/11.1.1/features/collaboration/presence-list.html:
  * 'collaborative-editing.html#theme-customization' - Collaborative editing guide
Error: Invalid internal links in /ckeditor5/11.1.1/framework/guides/architecture/editing-engine.html:
  * '../../../assets/img/framework-architecture-engine-diagram.png' -
  * '../../../assets/img/framework-architecture-engine-diagram.png' -
  * '#Conversion' - converters
  * '../../../assets/img/framework-architecture-engine-diagram.png' -
Error: Invalid internal links in /ckeditor5/11.1.1/framework/guides/support/browser-compatibility.html:
  * '#notes' - notes below
Error: Invalid internal links in /ckeditor5/11.1.1/framework/guides/support/error-codes.html:
  * '#overrideGravity' -

✅ Expected result

Links point to proper places and/or scroll page to correct section of document.

❎ Actual result

Links points just to pages does not scroll user to proper place.

📃 Other details that might be useful

bug docs

Source

msamsel

All 3 comments

@msamsel, these links are correct (I checked that they work):

Error: Invalid internal links in /ckeditor5/11.1.1/framework/guides/architecture/editing-engine.html:
  * '../../../assets/img/framework-architecture-engine-diagram.png' -
  * '../../../assets/img/framework-architecture-engine-diagram.png' -

It seems like a bug in Umberto.