Website: Improve how we display search results on the website

fleetdm / fleet

Open-source platform for IT, security, and infrastructure teams. (Linux, macOS, Chrome, Windows, cloud, data center)

https://fleetdm.com

Other

2.67k stars 380 forks source link

Website: Improve how we display search results on the website #19518

Open mike-j-thomas opened 1 month ago

mike-j-thomas commented 1 month ago

Merge https://github.com/fleetdm/fleet/issues/19893 before working on this ticket.

Goal

User story
As a Fleet user or Fleet team member searching fleetdm.com,
I want complete search results with more context and better categorization between reference docs, articles, and guides.

How

[ ] Add instantsearch.js to the website
[ ] Create the search page, add instantsearch.js widgets to that page, and style it to match

Changes

Figma: https://www.figma.com/design/3he8e72251IEnF6dBafKq1/%F0%9F%9A%A7-fleetdm.com-(scratchpad)?node-id=14157-70959

eashaw commented 1 month ago

To migrate to a new algolia account, we will need to:

Create a new algolia account and algolia crawler
Configure the new crawler to index the Fleet website (We can adjust the existing configuration to do this)
Replace all docsearch related dependencies and styles with algolia isntantsearch.js
Replace the docsearch searchbar in the docs, handbook, and table pages with instantsearch
Create the search page, format and style results returned from algolia to match wireframes

Estimation: 5 points

eashaw commented 1 month ago

I started setting up a new Algolia account to migrate our configuration, but when I was doing this, I realized that the hosted Algolia crawler is not included in any of the self-service plans that Algolia offers.

We will need to either host our own crawler, or contact Algolia to get a plan with an annual subscription. I will investigate the recommended way of hosting the crawler (I vaguely recall seeing a way of using GH actions to do this when we first set up DocSearch. I will see if I can find that)

eashaw commented 1 month ago

Updated scope:

[ ] Use existing DocSearch index & crawler. Update the configuration so that it indexes the entire Fleet website, and separate articles and documentation records. (Some articles are currently indexed as documentation)
[ ] Add instantsearch.js to the website (don't replace the DocSearch for now)
[ ] Create the search page, add instantsearch.js widgets to that page style it to match wireframes

Updated estimation: 3 points

mike-j-thomas commented 2 weeks ago

Thanks, @eashaw. Let's discuss when we meet.