Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add algolia search #984

Open
olizilla opened this issue Jul 17, 2020 · 10 comments · May be fixed by #1034
Open

Add algolia search #984

olizilla opened this issue Jul 17, 2020 · 10 comments · May be fixed by #1034
Labels
hint: beta Hint: Issues related to the beta branch

Comments

@olizilla
Copy link
Collaborator

olizilla commented Jul 17, 2020

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.

#969 (comment)

@olizilla olizilla added this to To do in beta.spec.filecoin.io via automation Jul 17, 2020
@olizilla
Copy link
Collaborator Author

@hugomrdias hugomrdias added the hint: beta Hint: Issues related to the beta branch label Jul 20, 2020
@hugomrdias hugomrdias added this to the Beta Launch milestone Jul 20, 2020
@olizilla
Copy link
Collaborator Author

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

Screenshot 2020-07-23 at 10 28 27

@yiannisbot
Copy link
Collaborator

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

algolia-howitworks

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

@olizilla
Copy link
Collaborator Author

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
Copy link
Collaborator Author

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 hugomrdias removed this from To do in beta.spec.filecoin.io Jul 28, 2020
@hugomrdias hugomrdias removed this from the Beta v1 milestone Jul 28, 2020
@hugomrdias
Copy link
Contributor

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

@olizilla
Copy link
Collaborator Author

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
Copy link
Contributor

hugomrdias commented Jul 30, 2020 via email

@olizilla
Copy link
Collaborator Author

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
Screenshot 2020-07-30 at 10 47 39

@olizilla olizilla linked a pull request Jul 30, 2020 that will close this issue
4 tasks
@yiannisbot
Copy link
Collaborator

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hint: beta Hint: Issues related to the beta branch
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants