Ckeditor5: [Docs] Add methods which should appear higher in search results

Created on 10 Oct 2017  路  5Comments  路  Source: ckeditor/ckeditor5

I plan to add importants array to docsearch config in umberto.json
The purpose of this is to make several API methods more important when performing a search

Example:

"docsearch": {
        "apiKey": "fc463c26455365ad403d5ec51796cd73",
        "indexName": "ckeditor_nightly",
        "importants": [
          "module:editor-balloon/ballooneditor~BalloonEditor.create",
          "module:editor-classic/classiceditor~ClassicEditor.create",
          "module:editor-inline/inlineeditor~InlineEditor.create",
          "module:core/editor/editor~Editor.create"
        ]
    }

Currently these methods don't appear in search results when a "create" search query is performed

docs

Most helpful comment

We could use a special tag, but I'm not 100% sure that boosting search results will work as expected, so I'd rather test it by hardcoding first (before putting effort into creating tag plugins and updating source code comments)

All 5 comments

Can you specify what is the point of this issue?

Sorry, updated the first comment

Maybe it could be done with a special tag instead of hardcoding if it's a more common problem?

We could use a special tag, but I'm not 100% sure that boosting search results will work as expected, so I'd rather test it by hardcoding first (before putting effort into creating tag plugins and updating source code comments)

Yep, this is fastest we can do and easiest to maintain actually.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Reinmar picture Reinmar  路  3Comments

MCMicS picture MCMicS  路  3Comments

hamenon picture hamenon  路  3Comments

hybridpicker picture hybridpicker  路  3Comments

oleq picture oleq  路  3Comments