crate / crate-docs-theme

A Sphinx theme for the CrateDB documentation.

Home Page:https://crate-docs-theme.readthedocs.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation search results - latest version documentation not always the first result

karynzv opened this issue · comments

Current behavior:
When searching in the documentation, the result can include pages referring to older versions of CrateDB even before the latest versions, as seen in the image below.

Screenshot 2023-05-04 at 11 00 33

Expected behavior:
When searching for a given topic in the documentation, the pages related to the latest release should be listed first. Unless, of course, the user explicitly added a given version on the search query. In that case, the search result should have the referred version documentation first.

@karynzv thanks to @WalBeh the 3.3 reference should be removed from the search results now, please test and lmk if this is what we wanted.

The results look much better now, thank you. However, on the third result position, there is still a blast from the past. Can you do something more about it?

image

-- https://crate.io/docs/crate/reference/en/latest/search.html?q=data+type

hmhm, now it's getting tricky again, how many repos with old versions do we have? Would it make more sense to include only /latest/ paths or wouldn't that work because of the reference-redirect?

so we can either exclude all old repos (manually) or include all current (latest) ones + the reference, wdyt @amotl?

I'm not entirely sure where that page comes from, since it's a v0,x and we don't even have that in the dropdown... But seeing that now, maybe excluding just 3.3 was the wrong approach.

Thanks for your investigations. I don't know much about the topic, and the corresponding tuning knobs. I just wanted to make you aware about what I've observed when also conducting the same search now, after you made some adjustments.

In this case, the single straw item pointing to a 0.52.1 resource is funny, but apparently does not hurt too much, because the link will be redirected appropriately by the redirection rule phalanx on Nginx.

So, feel free to close this ticket, and open different ones as you see fit.

0.52.1 is now removed as well, lmk if any others need excluding, thanks @WalBeh