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

Set up Algolia docsearch #669

Merged
2 commits merged into from
Dec 22, 2017
Merged

Set up Algolia docsearch #669

2 commits merged into from
Dec 22, 2017

Conversation

pimterry
Copy link
Contributor

@pimterry pimterry commented Dec 22, 2017

Connects-To: #143
Change-Type: minor

This enables https://community.algolia.com/docsearch/ - algolia provide free autoconfigured searching for documentation sites.

They're already automatically indexing our site (I think daily?), and we just need to drop in this config, to get a much nicer search experience out of the box. Exact code to do that came direct from the email they sent me.

Comparison of the results:

screenshot from 2017-12-22 12-16-08

vs

screenshot from 2017-12-22 12-15-47

This is mostly a quick proof of concept. Limitations:

  • I haven't removed the existing search code, which would break any links to search results, but we could look at doing that in future.
  • Algolia are only searching our prod site, so this makes the search box on non-prod sites (local & staging) link to prod pages regardless. Not sure if that's a problem.
  • I think there's a few places where we could restructure the docs to make this work more clearly (I think this is an issue with heading structure our end, e.g. lots of CLI results get listed under 'Table of Contents', rather than 'CLI documentation'), but I think we should ship & iterate on that later

Overall imo it's a clear improvement anyway, and a much nicer experience overall.
---- Autogenerated Waffleboard Connection: Connects to #143

Connects-To: #143
Change-Type: minor
Copy link
Contributor

@LucianBuzzo LucianBuzzo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome

@pimterry
Copy link
Contributor Author

I've also just found where our indexing configuration lives (by more successfully reading my emails).

We can open PRs to change it here: https://github.com/algolia/docsearch-configs/blob/master/configs/resin_io.json

@alisondavis17
Copy link
Contributor

Very nice @pimterry and definitely looks an improvement

@ghost ghost merged commit 6a2b5ff into master Dec 22, 2017
@ghost ghost deleted the add-algolia branch December 22, 2017 16:54
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants