# Getting Started
**URL:** https://discuss.elastic.co/t/getting-started/4436
**Category:** Elasticsearch
**Created:** [May 19, 2011, 9:35am UTC](https://discuss.elastic.co/t/getting-started/4436 "2011-05-19T09:35:18Z")
**Posts on this page:** 20
**Page:** 1
### Author:  [@Vectorjohn](https://discuss.elastic.co/u/Vectorjohn)
#### Post date: [May 19, 2011, 9:35am UTC](https://discuss.elastic.co/t/getting-started/4436/1 "2011-05-19T09:35:18Z")
I am really trying to use elastic search but I just can't seem to get
things to work consistently.
What I really need are examples. What is on the main website
([elasticsearch.org](http://elasticsearch.org)) is misc snippets that don't actually run on their
own. Does anyone know of a place I can go to look at actual working
examples? I'm thinking, creating an index (not a stupid toy twitter /
get by ID example), adding things to it, and then doing complicated
searches on it.
Thanks for any help.
---
### Author:  [@Karussell1](https://discuss.elastic.co/u/Karussell1)
#### Post date: [May 19, 2011, 12:54pm UTC](https://discuss.elastic.co/t/getting-started/4436/2 "2011-05-19T12:54:11Z")
Yes, docs needs to be improved in exactly this area.
My suggestion: go to freenode chat and ask if you can't get the things
done. Then document these things/queries and make a blog post ๐
If you are using Java API you can check out:
> **[GitHub - karussell/Jetwick: \[not maintained\] Custom Twitter Search via...](https://github.com/karussell/Jetwick)**
>
> \[not maintained\] Custom Twitter Search via ElasticSearch&Wicket - GitHub - karussell/Jetwick: \[not maintained\] Custom Twitter Search via ElasticSearch&Wicket
to see how to create indices.
On May 19, 11:35 am, Vectorjohn [vectorj...@gmail.com](mailto:vectorj...@gmail.com) wrote:
> I am really trying to use Elasticsearch but I just can't seem to get
> things to work consistently.
>
> What I really need are examples. What is on the main website
> ([elasticsearch.org](http://elasticsearch.org)) is misc snippets that don't actually run on their
> own. Does anyone know of a place I can go to look at actual working
> examples? I'm thinking, creating an index (not a stupid toy twitter /
> get by ID example), adding things to it, and then doing complicated
> searches on it.
>
> Thanks for any help.
---
### Author:  [@Karussell1](https://discuss.elastic.co/u/Karussell1)
#### Post date: [May 19, 2011, 12:54pm UTC](https://discuss.elastic.co/t/getting-started/4436/3 "2011-05-19T12:54:46Z")
BTW: ES-HEAD is the way to query from browser:
[http://mobz.github.com/elasticsearch-head/](http://mobz.github.com/elasticsearch-head/)
---
### Author:  [@kimchy](https://discuss.elastic.co/u/kimchy)
#### Post date: [May 19, 2011, 1:17pm UTC](https://discuss.elastic.co/t/getting-started/4436/4 "2011-05-19T13:17:31Z")
What exactly is missing in the getting started? Does the readme: [GitHub - elastic/elasticsearch: Free and Open, Distributed, RESTful Search Engine](https://github.com/elasticsearch/elasticsearch) not enough? Or the intro video: [Elasticsearch Platform โ Find real-time answers at scale | Elastic](http://www.elasticsearch.org/videos/2010/02/07/es-introduction.html).
On Thursday, May 19, 2011 at 12:35 PM, Vectorjohn wrote:
> I am really trying to use Elasticsearch but I just can't seem to get
> things to work consistently.
>
> What I really need are examples. What is on the main website
> ([elasticsearch.org](http://elasticsearch.org)) is misc snippets that don't actually run on their
> own. Does anyone know of a place I can go to look at actual working
> examples? I'm thinking, creating an index (not a stupid toy twitter /
> get by ID example), adding things to it, and then doing complicated
> searches on it.
>
> Thanks for any help.
---
### Author:  [@Theral\_Mackey](https://discuss.elastic.co/u/Theral_Mackey)
#### Post date: [May 19, 2011, 11:27pm UTC](https://discuss.elastic.co/t/getting-started/4436/5 "2011-05-19T23:27:23Z")
From my perspective also as a new user it drops you off with a running ES
server. All fine and dandy but it leaves out the part about how to integrate
a crawler, or feed content other than via running curl PUTs (which it
specifically states is not the way to do in production), and severely lacks
any configuration guide (just some hints on a few curl commands or that it
can use jquery... I would rather have the ability to know what Im doing than
just see wow, jquery! posted everywhere in the docs). I have gone and
started using OpenSearchServer (its gui is intuitive enough to figure out
most of what it can and cant do, even with a similar lack of docs) instead
until I can either gather enough info to get ES working with a crawler and
front-end (ed-head) or it gets updated and I can follow a more complete
guide. Even better would be a ES-Nutch how-to. I have seen enough discussion
about getting the projects working together, and the upcoming 3.1 nutch
release might have more for that, but any sort of "this is where it looks
for plugins or crawlers or other integration stuff" would be most helpful.
Docs right now seem more centered for devs to use to imbed it in existing
code rather than as a pure stand-alone (with minimal crawler and frontend)
search engine.
-T
On Thu, May 19, 2011 at 6:17 AM, Shay Banon [shay.banon@elasticsearch.com](mailto:shay.banon@elasticsearch.com)wrote:
> What exactly is missing in the getting started? Does the readme:
> [GitHub - elastic/elasticsearch: Free and Open, Distributed, RESTful Search Engine](https://github.com/elasticsearch/elasticsearch) not enough? Or the intro
> video: [Elasticsearch Platform โ Find real-time answers at scale | Elastic](http://www.elasticsearch.org/videos/2010/02/07/es-introduction.html)
> .
>
> On Thursday, May 19, 2011 at 12:35 PM, Vectorjohn wrote:
>
> I am really trying to use Elasticsearch but I just can't seem to get
> things to work consistently.
>
> What I really need are examples. What is on the main website
> ([elasticsearch.org](http://elasticsearch.org)) is misc snippets that don't actually run on their
> own. Does anyone know of a place I can go to look at actual working
> examples? I'm thinking, creating an index (not a stupid toy twitter /
> get by ID example), adding things to it, and then doing complicated
> searches on it.
>
> Thanks for any help.
---
### Author:  [@Theral\_Mackey](https://discuss.elastic.co/u/Theral_Mackey)
#### Post date: [May 19, 2011, 11:29pm UTC](https://discuss.elastic.co/t/getting-started/4436/6 "2011-05-19T23:29:06Z")
s/jquery/json/
too many j\* stuff in there
-T
On Thu, May 19, 2011 at 4:27 PM, Theral Mackey [tmackey@zetta.net](mailto:tmackey@zetta.net) wrote:
> From my perspective also as a new user it drops you off with a running ES
> server. All fine and dandy but it leaves out the part about how to integrate
> a crawler, or feed content other than via running curl PUTs (which it
> specifically states is not the way to do in production), and severely lacks
> any configuration guide (just some hints on a few curl commands or that it
> can use jquery... I would rather have the ability to know what Im doing than
> just see wow, jquery! posted everywhere in the docs). I have gone and
> started using OpenSearchServer (its gui is intuitive enough to figure out
> most of what it can and cant do, even with a similar lack of docs) instead
> until I can either gather enough info to get ES working with a crawler and
> front-end (ed-head) or it gets updated and I can follow a more complete
> guide. Even better would be a ES-Nutch how-to. I have seen enough discussion
> about getting the projects working together, and the upcoming 3.1 nutch
> release might have more for that, but any sort of "this is where it looks
> for plugins or crawlers or other integration stuff" would be most helpful.
> Docs right now seem more centered for devs to use to imbed it in existing
> code rather than as a pure stand-alone (with minimal crawler and frontend)
> search engine.
>
> -T
>
> On Thu, May 19, 2011 at 6:17 AM, Shay Banon [shay.banon@elasticsearch.com](mailto:shay.banon@elasticsearch.com)wrote:
>
> > What exactly is missing in the getting started? Does the readme:
> > [GitHub - elastic/elasticsearch: Free and Open, Distributed, RESTful Search Engine](https://github.com/elasticsearch/elasticsearch) not enough? Or the intro
> > video:
> > [Elasticsearch Platform โ Find real-time answers at scale | Elastic](http://www.elasticsearch.org/videos/2010/02/07/es-introduction.html).
> >
> > On Thursday, May 19, 2011 at 12:35 PM, Vectorjohn wrote:
> >
> > I am really trying to use Elasticsearch but I just can't seem to get
> > things to work consistently.
> >
> > What I really need are examples. What is on the main website
> > ([elasticsearch.org](http://elasticsearch.org)) is misc snippets that don't actually run on their
> > own. Does anyone know of a place I can go to look at actual working
> > examples? I'm thinking, creating an index (not a stupid toy twitter /
> > get by ID example), adding things to it, and then doing complicated
> > searches on it.
> >
> > Thanks for any help.
---
### Author:  [@Clinton\_Gormley](https://discuss.elastic.co/u/Clinton_Gormley)
#### Post date: [May 20, 2011, 8:25am UTC](https://discuss.elastic.co/t/getting-started/4436/7 "2011-05-20T08:25:56Z")
Hi Theral
Yes, we need more ES tutorials, and "introduction-to" articles.
On Thu, 2011-05-19 at 16:27 -0700, Theral Mackey wrote:
> From my perspective also as a new user it drops you off with a running
> ES server. All fine and dandy but it leaves out the part about how to
> integrate a crawler, or feed content other than via running curl PUTs
> (which it specifically states is not the way to do in production),
This kinda depends what language you want to use. There are several
APIs: most used are Java, Perl, Ruby, PHP, Python, and you may want to
try out elasticsearch-head for a simple Javascript console for making
requests: [GitHub - mobz/elasticsearch-head: A web front end for an elastic search cluster](https://github.com/mobz/elasticsearch-head)
This is why the examples are explained using curl - it's the "universal
language" that all of the APIs (except Java) translate their requests
into.
You may want to read through some of the blog entries on
[Elasticsearch Platform โ Find real-time answers at scale | Elastic](http://www.elasticsearch.org/blog/) - it will give you some taste for how
to use ES.
Also, here are a few examples in different languages:
- [http://ephemera.karmi.cz/post/5510326335/gmail-elasticsearch-ruby](http://ephemera.karmi.cz/post/5510326335/gmail-elasticsearch-ruby)
- [Elasticsearch Platform โ Find real-time answers at scale | Elastic](http://www.elasticsearch.org/blog/2011/05/13/data-visualization-with-elasticsearch-and-protovis.html)
- [ElasticSearch.pm gets big performance boost | Clinton Gormley [blogs.perl.org]](http://blogs.perl.org/users/clinton_gormley/2010/10/elasticsearchpm-gets-big-performance-boost.html)
- [Duplicates Detection with ElasticSearch ยป Andrei Zmievski](http://zmievski.org/2011/03/duplicates-detection-with-elasticsearch)
> and severely lacks any configuration guide (just some hints on a few
> curl commands or that it can use jquery...
The point about Elasticsearch is that you shouldn't configure anything.
At least, not until you actually have to. ES has got very good
defaults, and generally just works out of the box. When you have a
better idea of your encounter a problem, that's the time to see what you
can configure.
> I would rather have the ability to know what Im doing than just see
> wow, jquery! posted everywhere in the docs). I have gone and started
> using OpenSearchServer (its gui is intuitive enough to figure out most
> of what it can and cant do, even with a similar lack of docs) instead
> until I can either gather enough info to get ES working with a crawler
> and front-end (ed-head) or it gets updated and I can follow a more
> complete guide. Even better would be a ES-Nutch how-to. I have seen
> enough discussion about getting the projects working together, and the
> upcoming 3.1 nutch release might have more for that, but any sort of
> "this is where it looks for plugins or crawlers or other integration
> stuff" would be most helpful. Docs right now seem more centered for
> devs to use to imbed it in existing code rather than as a pure
> stand-alone (with minimal crawler and frontend) search engine.
Yes - it is early days and kimchy has been focused on developing a
powerful, easy-to-integrate search server which developers from any
language can use in their applications, in a way that makes sense for
their app.
It is now up to us, the community, to develop reusable "pluggable"
applications and write about specific use cases.
It sounds like you are looking for a prepackaged search service, rather
than a highly customisable search engine.
Perhaps have a look at Karmi's field notes which explain how he setup ES
search for the [elasticsearch.org](http://elasticsearch.org) website:
>
Your use case is one of many, and so far nobody has written that
particular app, although the easy part would be implementing search with
ES.
PS See my next email for an example in Perl
clint
---
### Author:  [@Clinton\_Gormley](https://discuss.elastic.co/u/Clinton_Gormley)
#### Post date: [May 20, 2011, 8:33am UTC](https://discuss.elastic.co/t/getting-started/4436/8 "2011-05-20T08:33:45Z")
Hi Theral
> PS See my next email for an example in Perl
I've put together a quick example of how you could crawl and search a
website in Perl.
crawl: [Crawl ElasticSearch blogposts ยท GitHub](https://gist.github.com/982551)
search: [Search ElasticSearch blogposts ยท GitHub](https://gist.github.com/982552)
To get this example running, you need to:
1. Download and install Elasticsearch (if you haven't already):
wget [http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.16.1.tar.gz](http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.16.1.tar.gz)
tar -xzf elasticsearch-0.16.1.tar.gz
cd elasticsearch-0.16.1
./bin/elasticsearch
1. Install Perl modules Web::Scraper and Elasticsearch.pm:
Easiest way to install Perl modules is using 'cpanm':
curl -L [http://cpanmin.us](http://cpanmin.us) | perl - --sudo App::cpanminus
Then:
cpanm Elasticsearch
cpanm Web::Scraper
1. Download crawl.pl and search.pl
curl [http://gist.github.com/gists/982552/download](http://gist.github.com/gists/982552/download) \> search.pl
curl [http://gist.github.com/gists/982551/download](http://gist.github.com/gists/982551/download) \> crawl.pl
1. Run it:
perl crawl.pl
perl search.pl
hth
clint
---
### Author:  [@Karussell1](https://discuss.elastic.co/u/Karussell1)
#### Post date: [May 20, 2011, 7:41pm UTC](https://discuss.elastic.co/t/getting-started/4436/9 "2011-05-20T19:41:04Z")
@Shay: I think Vectorjohn refers to some of the queries which cannot
run as they are printed. Most of the time not the full query (only the
important part) is listed in the docs. The problem for beginners (and
also sometimes for me ;)) is where they belongs to etc.
On May 19, 3:17 pm, Shay Banon [shay.ba...@elasticsearch.com](mailto:shay.ba...@elasticsearch.com) wrote:
> What exactly is missing in the getting started? Does the readme:[https://github.com/elasticsearch/elasticsearchnot](https://github.com/elasticsearch/elasticsearchnot) enough? Or the intro video:[Elasticsearch Platform โ Find real-time answers at scale | Elastic](http://www.elasticsearch.org/videos/2010/02/07/es-introduction.html).
---
### Author:  [@Paul\_Loy](https://discuss.elastic.co/u/Paul_Loy)
#### Post date: [May 20, 2011, 7:45pm UTC](https://discuss.elastic.co/t/getting-started/4436/10 "2011-05-20T19:45:40Z")
I kinda agree with that. Not just for queries but for config too. Perhaps we
can have an examples section where user-contributed examples can be placed
and linked to from the relevant sections? I'm happy to collate/contribute to
these.
On Fri, May 20, 2011 at 8:41 PM, Karussell [tableyourtime@googlemail.com](mailto:tableyourtime@googlemail.com)wrote:
> @Shay: I think Vectorjohn refers to some of the queries which cannot
> run as they are printed. Most of the time not the full query (only the
> important part) is listed in the docs. The problem for beginners (and
> also sometimes for me ;)) is where they belongs to etc.
>
> On May 19, 3:17 pm, Shay Banon [shay.ba...@elasticsearch.com](mailto:shay.ba...@elasticsearch.com) wrote:
>
> > What exactly is missing in the getting started? Does the readme:
> > [https://github.com/elasticsearch/elasticsearchnot](https://github.com/elasticsearch/elasticsearchnot) enough? Or the intro
> > video:[Elastic โ The Search AI Company | Elastic](http://www.elasticsearch.org/videos/2010/02/07/es-introduction.html).
## --
Paul Loy
[paul@keteracel.com](mailto:paul@keteracel.com)
[http://uk.linkedin.com/in/paulloy](http://uk.linkedin.com/in/paulloy)
---
### Author:  [@kimchy](https://discuss.elastic.co/u/kimchy)
#### Post date: [May 20, 2011, 7:50pm UTC](https://discuss.elastic.co/t/getting-started/4436/11 "2011-05-20T19:50:50Z")
The thing that I am concerned about is that this will quickly run out of control and sensible order.
The current state of docs has some logic in it. What is missing are "vertical" docs. For example, Analysis, what does it mean, how does it work, whats the meaning of it when mapping, whats the meaning of it when querying. This will include samples and so on.
Same can be applied to things like searching.
That vertical concepts area is something that I certainly plan to doc. Its a lot of work, and would love more help there. But, it has to be done with structure in mind, and not sprinkled here and there with samples. This will quickly get out of hand.
-shay.banon
On Friday, May 20, 2011 at 10:45 PM, Paul Loy wrote:
> I kinda agree with that. Not just for queries but for config too. Perhaps we can have an examples section where user-contributed examples can be placed and linked to from the relevant sections? I'm happy to collate/contribute to these.
>
> On Fri, May 20, 2011 at 8:41 PM, Karussell [tableyourtime@googlemail.com](mailto:tableyourtime@googlemail.com) wrote:
>
> > @Shay: I think Vectorjohn refers to some of the queries which cannot
> > run as they are printed. Most of the time not the full query (only the
> > important part) is listed in the docs. The problem for beginners (and
> > also sometimes for me ;)) is where they belongs to etc.
> >
> > On May 19, 3:17 pm, Shay Banon [shay.ba...@elasticsearch.com](mailto:shay.ba...@elasticsearch.com) wrote:
> >
> > > What exactly is missing in the getting started? Does the readme:[https://github.com/elasticsearch/elasticsearchnot](https://github.com/elasticsearch/elasticsearchnot) enough? Or the intro video:[Elasticsearch Platform โ Find real-time answers at scale | Elastic](http://www.elasticsearch.org/videos/2010/02/07/es-introduction.html).
>
> ## --
>
> Paul Loy
> [paul@keteracel.com](mailto:paul@keteracel.com)
> [http://uk.linkedin.com/in/paulloy](http://uk.linkedin.com/in/paulloy)
---
### Author:  [@Karussell1](https://discuss.elastic.co/u/Karussell1)
#### Post date: [May 20, 2011, 8:19pm UTC](https://discuss.elastic.co/t/getting-started/4436/12 "2011-05-20T20:19:18Z")
I completely agree with that ๐
but for the sake of just working examples (sometimes user needs a
lot!) a wiki would be very nice - even if sprinkled here and there.
I started a wiki here:
[http://elastic.wikispaces.com](http://elastic.wikispaces.com)
---
### Author:  [@Karussell1](https://discuss.elastic.co/u/Karussell1)
#### Post date: [May 20, 2011, 8:21pm UTC](https://discuss.elastic.co/t/getting-started/4436/13 "2011-05-20T20:21:00Z")
Aeh ... @shay: please let me know if I shouldn't do that. Don't want
to fork docs or something ...
On May 20, 10:19 pm, Karussell [tableyourt...@googlemail.com](mailto:tableyourt...@googlemail.com) wrote:
> I completely agree with that ๐
>
> but for the sake of just working examples (sometimes user needs a
> lot!) a wiki would be very nice - even if sprinkled here and there.
>
> I started a wiki here:
>
> [http://elastic.wikispaces.com](http://elastic.wikispaces.com)
---
### Author:  [@kimchy](https://discuss.elastic.co/u/kimchy)
#### Post date: [May 20, 2011, 8:21pm UTC](https://discuss.elastic.co/t/getting-started/4436/14 "2011-05-20T20:21:01Z")
What we can do is start a section in the site with samples. I prefer not to have several places of docs around for elasticsearch. And the site is, effectively, a wiki (anybody can edit and send pull requests).
On Friday, May 20, 2011 at 11:19 PM, Karussell wrote:
> I completely agree with that ๐
>
> but for the sake of just working examples (sometimes user needs a
> lot!) a wiki would be very nice - even if sprinkled here and there.
>
> I started a wiki here:
>
> [http://elastic.wikispaces.com](http://elastic.wikispaces.com)
---
### Author:  [@Karussell1](https://discuss.elastic.co/u/Karussell1)
#### Post date: [May 20, 2011, 8:41pm UTC](https://discuss.elastic.co/t/getting-started/4436/15 "2011-05-20T20:41:07Z")
> I prefer not to have several places of docs around for elasticsearch.
ok.
> And the site is, effectively, a wiki (anybody can edit and send pull requests).
Yes and no, the problem is (like I told you some months ago). That it
is not easy as a wiki: you need to get the doc server up and running +
git etc.
Probably not something were users will fix minor typos or contribute
minor queries etc.
That being to said, the solr wiki works pretty well IMO.
What do you think?
---
### Author:  [@plaflamme](https://discuss.elastic.co/u/plaflamme)
#### Post date: [May 20, 2011, 8:42pm UTC](https://discuss.elastic.co/t/getting-started/4436/16 "2011-05-20T20:42:12Z")
What I find is missing most in the docs is a top-down description of the
Query DSL: what is the possible structure of a search request body. It's all
in the docs, but split into many little pieces which makes the "vertical"
view (as Shay puts it) difficult to grasp. This is even complicated further
by the fact that some pieces can go in multiple places (a query within a
filter for example).
What would be very useful is a formal description of the Query DSL (similar
to what an XSD offers to XML). No, not that complicated, but it would be
complete (covers all possibilities) and would show what is required and what
is optional for each "node" type. And, while I'm dreaming, it would also be
clickable so you could drill-down.
The facet documentation has a formal description (uses and
such) but is incomplete (each example only shows part of what is
available): [Elasticsearch Platform โ Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/api/search/facets/)
I'm not too familiar with the code that parses the queries, but could such a
document be generated from the code? Maybe using annotations or
introspection or whatever, that would make it easily maintainable...
I'd like to contribute if that makes any sense to anyone.
Philippe
On Fri, May 20, 2011 at 16:21, Shay Banon [shay.banon@elasticsearch.com](mailto:shay.banon@elasticsearch.com)wrote:
> What we can do is start a section in the site with samples. I prefer not to
> have several places of docs around for elasticsearch. And the site is,
> effectively, a wiki (anybody can edit and send pull requests).
>
> On Friday, May 20, 2011 at 11:19 PM, Karussell wrote:
>
> I completely agree with that ๐
>
> but for the sake of just working examples (sometimes user needs a
> lot!) a wiki would be very nice - even if sprinkled here and there.
>
> I started a wiki here:
>
> [http://elastic.wikispaces.com](http://elastic.wikispaces.com)
---
### Author:  [@Karussell1](https://discuss.elastic.co/u/Karussell1)
#### Post date: [May 20, 2011, 8:43pm UTC](https://discuss.elastic.co/t/getting-started/4436/17 "2011-05-20T20:43:29Z")
Would it be an option to point to the wiki of ElasticSearch for the
'sprinkled here and there' examples section?
---
### Author:  [@kimchy](https://discuss.elastic.co/u/kimchy)
#### Post date: [May 20, 2011, 8:53pm UTC](https://discuss.elastic.co/t/getting-started/4436/18 "2011-05-20T20:53:34Z")
Not going to stand in the way of a wiki, but I am certainly not going to spend any time there. There is enough things to do already. I hope there won't be one since it will create confusion for users as wikis tend to quickly get out of date, and its not maintained in the way that the guide is.
If someone can't figure out how to run the github site, then its fine by me that he won't contribute docs.
-shay.banon
On Friday, May 20, 2011 at 11:41 PM, Karussell wrote:
I prefer not to have several places of docs around for elasticsearch.
> ok.
>
> > And the site is, effectively, a wiki (anybody can edit and send pull requests).
>
> Yes and no, the problem is (like I told you some months ago). That it
> is not easy as a wiki: you need to get the doc server up and running +
> git etc.
>
> Probably not something were users will fix minor typos or contribute
> minor queries etc.
>
> That being to said, the solr wiki works pretty well IMO.
>
> What do you think?
---
### Author:  [@kimchy](https://discuss.elastic.co/u/kimchy)
#### Post date: [May 20, 2011, 8:54pm UTC](https://discuss.elastic.co/t/getting-started/4436/19 "2011-05-20T20:54:00Z")
No.
On Friday, May 20, 2011 at 11:43 PM, Karussell wrote:
> Would it be an option to point to the wiki of Elasticsearch for the
> 'sprinkled here and there' examples section?
---
### Author:  [@kimchy](https://discuss.elastic.co/u/kimchy)
#### Post date: [May 20, 2011, 8:55pm UTC](https://discuss.elastic.co/t/getting-started/4436/20 "2011-05-20T20:55:35Z")
There is no way to generate it automatically, but contributions are warmly welcomed.
On Friday, May 20, 2011 at 11:42 PM, Philippe Laflamme wrote:
> What I find is missing most in the docs is a top-down description of the Query DSL: what is the possible structure of a search request body. It's all in the docs, but split into many little pieces which makes the "vertical" view (as Shay puts it) difficult to grasp. This is even complicated further by the fact that some pieces can go in multiple places (a query within a filter for example).
>
> What would be very useful is a formal description of the Query DSL (similar to what an XSD offers to XML). No, not that complicated, but it would be complete (covers all possibilities) and would show what is required and what is optional for each "node" type. And, while I'm dreaming, it would also be clickable so you could drill-down.
>
> The facet documentation has a formal description (uses and such) but is incomplete (each example only shows part of what is available): [Elasticsearch Platform โ Find real-time answers at scale | Elastic](http://www.elasticsearch.org/guide/reference/api/search/facets/)
>
> I'm not too familiar with the code that parses the queries, but could such a document be generated from the code? Maybe using annotations or introspection or whatever, that would make it easily maintainable...
>
> I'd like to contribute if that makes any sense to anyone.
>
> Philippe
>
> On Fri, May 20, 2011 at 16:21, Shay Banon [shay.banon@elasticsearch.com](mailto:shay.banon@elasticsearch.com) wrote:
>
> > What we can do is start a section in the site with samples. I prefer not to have several places of docs around for elasticsearch. And the site is, effectively, a wiki (anybody can edit and send pull requests).
> > On Friday, May 20, 2011 at 11:19 PM, Karussell wrote:
> >
> > > I completely agree with that ๐
> > >
> > > but for the sake of just working examples (sometimes user needs a
> > > lot!) a wiki would be very nice - even if sprinkled here and there.
> > >
> > > I started a wiki here:
> > >
> > > [http://elastic.wikispaces.com](http://elastic.wikispaces.com)
[Next page](https://discuss.elastic.co/t/getting-started/4436.md?page=2)