karmi/tire — pull request #165 by ifesdjeen (2011-12-10 16:37:54+00:00)
Title: Docs & call to discussion on tire

Hi Karel, hi Vojtěch!

Thanks a lot for an amazing work on Tire!

We're using ElasticSearch and Tire on several projects of ours. We switched over from Solr, and it was a deliberate decision. @michaelklishin from our team have recently added some integration specs for Mongoid. Now he's working more on a heavy lifting, so I had to take over Rails app and parts that involve search, too.

Even though our our use-cases are not that complex, many things were not clear from Readme, so I went through the complete ElasticSearch doc and most of Tire source code and issues to understand some concepts (for example, nested models). Also, data types, and some other things. Since we used Solr, we were already familiar with analyzers and core concepts, so background knowledge helped.

It's by no means a complete pull request, but while writing these things I discovered even more things I'd want to have in readme/wiki/doc, so I thought that I should talk to you guys before I proceed, since if you don't see that useful, I'll just write an internal doc for now.

My proposal would be to document and add even more integration specs for all three existing adapters and create a reference doc with some examples for people who were not yet familiar with full-text-search, give them some hints (like, that it's better to use "keyword" analyzer for things like tags and "snowball" for titles and article texts etc), maybe some more elaborate examples, and create something that will put together current readme, http://karmi.github.com/tire/ rocco doc and create a more complete wiki, with more examples and more information, which (of course) will partially duplicate one from elasticsearch.org.

Let me know what you think. Since you guys created Tire, you know your final destination, but if you consider that helpful, I would be happy to keep pushing things to that pull request and get to know your thoughts!

Thanks!