search

webpack / webpack.js.org

Repository for webpack documentation and more!
https://webpack.js.org
Creative Commons Attribution 4.0 International
2.21k stars 3.31k forks source link

Set up search for the site #184

Closed bebraw closed 8 years ago

bebraw commented 8 years ago

Algolia would work.

I'm opening this based on Twitter discussion.

joshed-io commented 8 years ago

Great! Per the comment on Twitter, what thoughts did you have in mind for the design?

bebraw commented 8 years ago

@dzello Mostly fine. The structure of the site is completely different now, though, so that might affect your side. The search control needs a good location. Maybe header? See http://webpack.js.org/ .

joshed-io commented 8 years ago

Ok, good to know. If the new content structure is different that's ok, I will have to make some config changes but should be mostly painless. From clicking around on the new site it looks like some content isn't there yet. Should I hold off on trying to index it until there's more there?

The header is good for location, that's what we did on the React docs.

bebraw commented 8 years ago

You can index it, but it's correct it won't yield a lot of results yet. But then, I assume you index it regularly so going with the new structure can't hurt.

joshed-io commented 8 years ago

Right, once the config is live we re-index every 24 hours to pick up any changes. I will play with indexing the new site and see where I get. Any ideas for timeline on having all the new content up?

bebraw commented 8 years ago

All content - months.

Minimum will take less. There's a target for that.

joshed-io commented 8 years ago

Sounds good, no problem to get new indexing configuration done by then.

In the meantime, for the sake of asking, do you think it's worth deploying search for the existing docs since the PR is ready to go? I don't want to make extra work but one upside of deploying for the existing docs is that we'll have more data to improve search for V2.

bebraw commented 8 years ago

@dzello Yeah, getting the search on the old site could be worthwhile. Just poked about that so we get a decision made.

sokra commented 8 years ago

google custom search can work too...

joshed-io commented 8 years ago

The Google custom search UX isn't great for docs. No autocomplete, irrelevant suggested searches, clumsy modal dialog for displaying results. Also there's ads and you have to pay to remove them.

SpaceK33z commented 8 years ago

I'm +1 for Algolia. Laravel also uses this on their docs, and having used those docs extensively, I can say that it's very nice to work with. I especially like the autocomplete which allows me to quickly navigate. If it's free, I don't see any disadvantage.

jhnns commented 8 years ago

If a documentation site uses google custom search, I'm instantly annoyed ^^. I don't like the results.

SpaceK33z commented 8 years ago

@dzello, are you still interested in adding search for this repo? We'd love it if you could do a PR :).

joshed-io commented 8 years ago

@SpaceK33z yes, I will start getting that together :)

bebraw commented 8 years ago

@dzello Could you provide us the api key + webpack id for Algolia API? It should be straight-forward to set up after that once you have indexing going (just did integration of my own).

joshed-io commented 8 years ago

@bebraw Yes, will provide once I have indexing going. In the meantime for development or testing you could use the DocSearch index for the existing site. App Id: bh4d9od16a, API Key: 93950c6eda05068a6f0649e4a7f7546e, Index name: webpack.

skipjack commented 8 years ago

@bebraw @dzello Started working on a branch to add the interface bits (e.g. a togglable input in the Navigation bar) for you to hook into, haven't it pushed it yet by I should be able to open a PR for that sometime tonight or tomorrow.

joshed-io commented 8 years ago

Good to know @skipjack, thanks!

SpaceK33z commented 8 years ago

Fixed with PR #284.