Add algolia search

[olizilla]

Somewhat prescriptive this one, but we've had a good experience with the UX of Algolia search in the past, and it's not too much work to add, and could strike a balance of still being able to find everything quickly without needed to load MBs of HTML.

https://github.com/filecoin-project/specs/pull/969#issuecomment-659965851

[olizilla]

[olizilla]

I have applied for https://docsearch.algolia.com/

[yiannisbot]

This is the process of integrating algolia, for those not familiar:

@olizilla do you have an estimate of how long it takes before we can integrate it to our site?

[olizilla]

Docsearch is like algolia premium, and is easy to add, just needs some UI work. It's less than half a days work. But first they have to deem us worthy. I am waiting to here back. I expect a response will land today. If not I'll work on adding it manually on Monday, and is about 1 days work.

The difference is with the docsearch solution, we dont have to set up algoila at all, just add a js script to the page and they do all the scraping. Without that, we have to import our content to their servers and set up an action to re-import it when the main branch changes. With docsearch they scrape the deployed site for for us every 24 hours. If we get accepted, the docsearch solution is preferable. If we don't then I'll do the extra leg work.

[olizilla]

I'm offline today, but will announce if they get back to me. If anyone else wants to pick this up in the meantime, then feel free.

[hugomrdias]

Should we close this or still get the account even if we dont plan to use it ?

[olizilla]

DocSearch is positive. I will PR the gubbins to wire it up. With single page site, folks that want to use the browser built in search can do so, and those who want stemming and typo-proof searching can use the algolia powered one.

Hi Oli 👋 Thanks for your interest! This is great news to know that you'd like to entrust your search to DocSearch. A good search experience is key to help your users discover your content.

DocSearch is built in two parts: – a crawler which we run on our own infrastructure every 24 hours. It follows every link in your website and extract content > from every page it traverses. It then pushes this content to an Algolia index. – a JavaScript snippet to be inserted in your website that will bind this Algolia index to your search input and display its results in a dropdown UI. If you want to find more details on how works DocSearch, check our docs.

For implementing the search auto-complete of DocSearch, you'll need to insert a small JavaScript snippet in the page: are you able to do that? Are you a maintainer of the website? Please confirm by replying this email.

[hugomrdias]

Nice

Hugo Dias

On Thu, Jul 30, 2020, 09:42 Oli Evans notifications@github.com wrote:

DocSearch is positive. I will PR the gubbins to wire it up. With single page site, folks that want to use the browser built in search can do so, and those who want stemming and typo-proof searching can use the algolia powered one.

Hi Oli 👋 Thanks for your interest! This is great news to know that you'd like to entrust your search to DocSearch. A good search experience is key to help your users discover your content.

DocSearch is built in two parts: – a crawler which we run on our own infrastructure every 24 hours. It follows every link in your website and extract content > from every page it traverses. It then pushes this content to an Algolia index. – a JavaScript snippet to be inserted in your website that will bind this Algolia index to your search input and display its results in a dropdown UI. If you want to find more details on how works DocSearch, check our docs.

For implementing the search auto-complete of DocSearch, you'll need to insert a small JavaScript snippet in the page: are you able to do that? Are you a maintainer of the website? Please confirm by replying this email.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/filecoin-project/specs/issues/984#issuecomment-666232134, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACMWTWUM4FSKEQEGBQMZ5DR6EW7VANCNFSM4O6KKGPA .

[olizilla]

As suggested in the docsearch docs we can test it out using the search results for the docsearch docs while we wait for them to index our docs. Also of note, they maintain a public repo with all the configs for the 2000+ other sites they are indexing https://github.com/algolia/docsearch-configs/tree/master/configs

WIP

[yiannisbot]

While working on, but also reading through the spec, I am finding that it would be really great to have algolia search, in addition to the "ctrl+F" that is natively supported.

@hugomrdias @olizilla would it be a disproportionate amount of effort to finalise this, given we already started it a while ago?