quarkusio / quarkus

Quarkus: Supersonic Subatomic Java.
https://quarkus.io
Apache License 2.0
13.54k stars 2.61k forks source link

Improve doc search experience on Quarkus docs landing page to include full-text search #33215

Open michelle-purcell opened 1 year ago

michelle-purcell commented 1 year ago

Description

When you search for information on the Quarkus docs home page by using a keyword string on the search bar, the search results are limited to matches in the title, summary, (1st sentence:abstract/preamble), or header keywords.

The text in the main body of a guide is not included in the search indexing so readers cannot find content about popular technology examples such as postgresql. If you search for 'postgresql` today, you find zero doc results. This is "working as designed" and because examples of product/service/component nouns in content can often be mentioned deeper into the main body of the content guide rather than the heading part.

Implementation ideas

Would be better if the Jekyll search in Quarkus feature was extended to support a full-text search rather than a simple 'light' keyword search.

If this is not possible, the Quarkus doc contributor guide and templates also need to make it clearer so that keywords are included somewhere in the title, abstract or header section of the adoc.

quarkus-bot[bot] commented 1 year ago

/cc @MichalMaler (documentation), @ebullient (documentation), @hmanwani-rh (documentation), @inoxx03 (documentation), @sheilamjones (documentation), @sunayna15 (documentation)

michelle-purcell commented 11 months ago

Thanks @yrodiere.