search

devspace-sh / devspace

DevSpace - The Fastest Developer Tool for Kubernetes ⚡ Automate your deployment workflow with DevSpace and develop software directly inside Kubernetes.
https://devspace.sh
Apache License 2.0
4.19k stars 351 forks source link

Algolia search broken (and documented fix) #2201

Closed jschalz closed 1 year ago

jschalz commented 1 year ago

Summary:

The Algolia integration for DevSpace broke when updating docusaurus from v1 to v2. The presenting issue was no search results populating despite search terms guaranteed to produce results. This included initial search, and the "see all results" function.

In order to fix this, @jschalz took steps to adjust the Algolia config as seen in this community post. The config was updated to include more "facets" represented in the site's source.

In the future, if results aren't correct, the "facet filtering" config should be checked again to ensure parity between the site source and facets.

Next steps:

@jschalz will investigate adding a config file for Algolia to more programmatically update facets, rather than manually adding them in the browser app.

@jschalz will also add a step to the DevSpace README.md to maintain maintenance records.

jschalz commented 1 year ago

This issue was created to document a fix for future reference.