search

webpack / docs

[OLD] documentation for webpack
http://webpack.github.io/docs/
1.46k stars 127 forks source link

Add autocomplete search via DocSearch project #78

Closed joshed-io closed 8 years ago

joshed-io commented 8 years ago

This PR adds search to the webpack documentation based on the DocSearch project. The search index is updated by Algolia automatically every 24 hours. The configuration for the indexing process lives in docsearch-configs/configs/webpack.json.

Here's a screenshot of the search box and the results overlay.

Searching webpack docs

bebraw commented 8 years ago

@TheLarkInn Any thoughts on this? Looks like a good addition to the site.

joshed-io commented 8 years ago

Here's a link to a live version so you can see it in action.

joshed-io commented 8 years ago

I saw your note on the new docs repo, @SpaceK33z. What do you think about this PR for the current docs? The idea is that we could start learning about query patterns to optimize the search relevance for the new site. (I'll be happy to share all the data from the Algolia side).

SpaceK33z commented 8 years ago

Looks very good @dzello.

I personally don't like serving things from a CDN except when used with an integrity attribute, but I don't know how the rest thinks of that?

joshed-io commented 8 years ago

Good idea to add that attribute @SpaceK33z, will add a commit for that soon.

joshed-io commented 8 years ago

Commit for SRI added, fixed to version 2.1.8. Does this look good?

SpaceK33z commented 8 years ago

Very nice @dzello. It looks good to me. @TheLarkInn, maybe you can also review this & merge if you're fine with it?

TheLarkInn commented 8 years ago

This looks fine from what I can tell. I'm not crazy about slapping minified source code that we have more vetted first, but I suppose we can not review that source. Otherwise this looks good to me.

joshed-io commented 8 years ago

@TheLarkInn The source is something you can review actually, and totally understand wanting to be cautious. Here are links to the un-minified CSS source and un-minified JS, and the original source for those comes from algolia/docsearch.

TheLarkInn commented 8 years ago

This looks good to me. Thanks for the clarification.

TheLarkInn commented 8 years ago

Thank you.

SpaceK33z commented 8 years ago

Oh yeah! Thanks again @dzello, if only I had this when learning webpack haha.

joshed-io commented 8 years ago

Awesome! 😀 Anything I/we need to do to deploy it?

@SpaceK33z Yeah! It should make the search-learn loop faster for new users, a lot faster than jumping back and forth between the docs and Google anyway :)

joshed-io commented 8 years ago

Small ping here for someone to deploy the changes, so we don't forget :) @SpaceK33z @TheLarkInn @bebraw