documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Add more algolia ranking

Open lorensr opened this issue 3 years ago • 2 comments

Required

What is the issue? What is the expected behavior?

Often when searching for general terms, the most likely desired articles are not listed first in search. Here, I likely want /retry-policies:

image
  • https://docs.temporal.io/retry-policies
  • Or maybe: https://docs.temporal.io/application-development-guide#activity-retry-policy

Here:

image

I'd likely want:

  • /concepts/what-is-a-search-attribute https://docs.temporal.io/concepts/what-is-a-search-attribute
  • /application-development/observability#visibility: https://docs.temporal.io/next/application-development/observability#visibility

Solutions

Rank sections

Maybe something like:

(higher appears first in results)

  • root-level: 1000
  • /application-development: 900
  • /concepts: 800
  • /<lang>: 200
  • /server and /cluster: 100
  • /references: 0
  • rest: 400

Rank individual pages

After we rank sections, for cases in which we still don't have the ideal order, we can do page-specific rankings, like:

  • /concepts/what-is-a-search-attribute: 950

to get it above app dev guide.

Implementation

https://docsearch.algolia.com/docs/record-extractor#boost-search-results-with-pagerank

goes into:

https://docsearch.algolia.com/docs/templates#docusaurus-v2-template

lorensr avatar Jul 18 '22 00:07 lorensr

If I search for schedules I only get the tctl reference, was expecting to reach this:

https://docs.temporal.io/workflows/#schedules

lorensr avatar Aug 13 '22 04:08 lorensr

Rank these two pages first for search term "config/configuration":

Cluster: https://docs.temporal.io/references/configuration UI: https://docs.temporal.io/references/ui-configuration

lorensr avatar Sep 13 '22 19:09 lorensr