Algolia search

[bravo-kernel]

Now that we have been added to Algolia DocSearch, this PR enables the SearchBar for the website.

Good to know:

• Crawler: search results only get updates after the Algolia crawler has indexed the site, runs once every 24 hours
• Contextual Search: Docusaurus supports contextual search meaning users browsing the v4 website should only see v4 matches in the SearchBar

PLEASE NOTE: if I understand correctly, contextual search requires a new crawl after this PR is merged (because meta tags will be added to the website). Therefore, after merging the search box will not produce results until the next crawl.

SearchBar position

I propose positioning the SearchBar at this location:

Alternative locations could be.

Left-most

Right-most

After internal pages

[bravo-kernel]

@nohwnd to test the various SearchBar locations locally:

1. clone locally
2. run yarn start
3. move the lines below (to a different order inside the items array)

   docs/docusaurus.config.js

   Lines 42 to 45 in 2d0e4c0

   	{
   	type: 'search', // algolia search
   	position: 'right',
   	},

[nohwnd]

@bravo-kernel I like the location that you proposed the most as well.

[bravo-kernel]

Let's merge it then and 🙏 the SearchBox contains content tomorrow :)

[nohwnd]

done

[fflaten]

Should have been crawled now, right? Any ideas why there's still no results?

[bravo-kernel]

Yes, I noticed the same. It looks like the contextual search filters that are being sent by Docusaurus are not working as expected (for our specific case, where we are using current as v5). I will ask for some support somewhere this week.

[nohwnd]

Great. I went to re-check a minute ago as well, and still the same :)

[bravo-kernel]

Just FYI Docusaurus is producing the correct tags, it seems facet filtering on these tags needs to be configured inside Algolia. However, I cannot find the option in their interface yet. I am quite busy with work so this might take some days.

[bravo-kernel]

Found the root cause.

There is no GUI option when using the free/open-source web interface. Instead, facet filtering must be enabled by creating a Pull Request on the Algolia DocSearch configs repository.

Our Pester config was created using the Algolia defaults and thus need to be updated so the config looks similar to this example.

I will not be able to look at this until this weekend so feel free to pick this up if it is required sooner.

[bravo-kernel]

PR now open at algolia/docsearch-configs#4540

[bravo-kernel]

PR has been merged, search is now working as expected 🎉 .

To test contextual search:

• try searching for gherkinstep when in the v5 website context
• then switch to the v4 website and search for the same term

Pretty amazing stuff, happy tweeting, do not forget to tag @algolia.

[fflaten]

Looks and works great! Awesome job @bravo-kernel 👏