Searchbar for Arrow Docs #898
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
calvellido
requested review from
raulraja,
pakoito,
israelperezglez and
JorgeCastilloPrz
JorgeCastilloPrz
approved these changes
Jun 20, 2018
There was a problem hiding this comment.
Wow, incredible job, it looks amazing! This is gonna become really handy for people browsing the docs. Great job @calvellido! 👏 👏 👏 👏
RawToast
pushed a commit
to RawToast/kategory
that referenced
this pull request
Jul 18, 2018
* Add proper styling for the searchbar * Add Arrow styling for the search results dropdown * Hide unnecessary X on search input elements on Chromium and Edge * Add JS code to call Algolia docsearch API. Including autofocus feature.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds search functionality to Arrow Docs.
It is based on the Algolia DocSearch service, which is offered for free for open source projects. But in case we want to, we can run the scraper ourselves.
General documentation is here:
https://community.algolia.com/docsearch/documentation/docsearch/introduction/
The scraper configuration for Arrow Docs can be found here:
https://github.com/algolia/docsearch-configs/blob/master/configs/arrow.json
A PR can be submitted there in case we want to change the way the docs are analyzed, following the guidelines detailed here. The underlying crawler runs every 24h.
The SASS has been added to our build process, and the JavaScript has been compiled from Algolia sources and minified. The repositories containing the source code for this can be found on:
https://github.com/algolia/docsearch
https://github.com/algolia/autocomplete.js
Completed tasks:
This closes #808