Enable contextual search in documentation

redhat-developer / odo

odo - Developer-focused CLI for fast & iterative container-based application development on Podman and Kubernetes. Implementation of the open Devfile standard.

https://odo.dev

Apache License 2.0

794 stars 243 forks source link

Enable contextual search in documentation #6198

Closed rm3l closed 2 years ago

rm3l commented 2 years ago

/area documentation /kind user-story

User Story

As a user, I want to see results that are relevant to the current version of the documentation I am reading, so that I am finding the right information I need.

This would fix the issue of having v2-related results when doing some search while reading the latest v3 documentation.

More details on https://docusaurus.io/docs/search#contextual-search

Acceptance Criteria

[ ] Search on odo.dev should scope results to the current language and version

Links

Related Epic (mandatory): —

/kind user-story

dharmit commented 2 years ago

More details on https://docusaurus.io/docs/search#contextual-search

I had a feeling that this issue and https://github.com/redhat-developer/odo/issues/6194 are related because when I search the site for "binding", it doesn't show me anything from odo v3. But in the docusaurus docs, I read that contextual search is enabled by default. It's the first line in the aforementioned link.

For the case of #6194, I am going to mail the Aloglia support as mentioned in this Slack thread and see if something's wrong with contextual search for odo website.

rm3l commented 2 years ago

Indeed, these two issues are related. Now that the search index has been refreshed (see https://github.com/redhat-developer/odo/issues/6194#issuecomment-1273006892), contextual search is working just fine on the website.

/close