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
merged 2 commits into from Dec 22, 2017

Conversation

Projects
None yet
4 participants
@pimterry
Member

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

Set up Algolia docsearch
Connects-To: #143
Change-Type: minor

@pimterry pimterry requested review from zwalchuk and LucianBuzzo Dec 22, 2017

@LucianBuzzo

Awesome

@pimterry

This comment has been minimized.

Show comment
Hide comment
@pimterry

pimterry Dec 22, 2017

Member

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

Member

pimterry commented Dec 22, 2017

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

This comment has been minimized.

Show comment
Hide comment
@alisondavis17

alisondavis17 Dec 22, 2017

Contributor

Very nice @pimterry and definitely looks an improvement

Contributor

alisondavis17 commented Dec 22, 2017

Very nice @pimterry and definitely looks an improvement

@resin-io-versionbot resin-io-versionbot bot merged commit 6a2b5ff into master Dec 22, 2017

4 checks passed

AutoMerges PR merging is in progress
Reviewers 2/1 review approvals met
Versionist Found all required commit footer tags
ci/circleci Your tests passed on CircleCI!
Details

@resin-io-versionbot resin-io-versionbot bot deleted the add-algolia branch Dec 22, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment