Improve Algolia search result experience

[udda1996]

Description

Currently we don't get Ballerina.io search results due to some results prioritization issue. We need to update the configs and improve the results ranking

Related website/documentation area

Add/Uncomment the relevant area label out of the following.

Area/UIUX

Describe the problem(s)

A detailed description of the purpose of this improvement.

Describe your solution(s)

A detailed description of how this improvement will solve the problem described above.

[praneesha]

Need to address the items below with respect to the Algolia search implementation.

algolia.com/blog/ux/what-are-predictive-search-and-autocomplete/ could be helpful in configuring the items below in Algolia.

• Implement the search hierarchy below.

1. ballerina.io/learn
2. ballerina.io/learn/by-example
3. https://lib.ballerina.io/
4. https://ballerina.io/why-ballerina/
5. https://ballerina.io/downloads/swan-lake-release-notes/ (exclude old release notes)
6. https://ballerina.io/downloads/
7. ballerina.io (community, Language walkthrough, legal pages etc.)
8. Blog.ballerina.io
9. https://ballerina.io/spec/ (will be only 1 or 2 entries. Group the entries of the same page into one.

• Implement a search results page presenting the categorization of the different Ballerina doc components (e.g., API Docs, BBEs, Learn pages etc.) (Refer https://www.algolia.com/search/)

• Learn pages (including Why Ballerina)

• Specs (crawl upto level 6 headings)

• BBEs (crawl code comments)

• API Docs

• Other (Blog, Community, legal pages, download etc.)

• All

• Implement the search logic below.

• Exact match with this ordering (everywhere)
  HTTP -> lib.ballerina.io

• Partial match with this ordering (There only in BBE/Why Ballerina)
  HTTPS -> lib.ballerina.io

• Crawl BAL file code comments in Algolia (e.g., mime, quoted identifiers)

• Crawl keywords on the BBE HTML in Algolia. (https://www.algolia.com/doc/guides/managing-results/optimize-search-

• Include spec.ballerina.io content in Algolia search.

• Make Algolia to detect partial words (when searching for parse vs parsing, read vs reading)

• Check if we have analytical support in Algolia (what are the keywords people are searching for etc.)

• Hyperlinks are not crawled in Algolia (e.g., the word mime https://ballerina.io/learn/by-example/http-response-with-multiparts.html)

• When I search interceptor in the search bar it suggests the Request Interceptor BBE. But when I search for constraint or serialization I could not get any link to the following newly added BBEs. The BBEs consist the exact words in them.

1. Constraint BBE
2. SerDes BBE

• When we search for Slack, results appear for the word Stack also.
  

• Get BBEs in the search results based on the keywords included in the content of them. Website search does not suggest newly added BBEs #5505

• Check with Algolia whether we can crawl the slides (for the Language walkthrough page) .

[praneesha]

Should address this also.

[praneesha]

We won't be addressing the below out of the items listed in #5944 (comment).

1. Implement the search hierarchy below.
2. Crawl BAL file code comments in Algolia (e.g., mime, quoted identifiers)