Skip to content

Commit 435459d

Browse files
author
Simonas Šerlinskas
committed
update readme
1 parent 4974d83 commit 435459d

File tree

1 file changed

+50
-15
lines changed

1 file changed

+50
-15
lines changed

README.md

Lines changed: 50 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# ONGR Elasticsearch Bundle
22

33
Elasticsearch Bundle was created in order to serve the need for
4-
professional [Elasticsearch](https://www.elastic.co/products/elasticsearch) integration with enterprise level Symfony
4+
professional [Elasticsearch][1] integration with enterprise level Symfony
55
applications. This bundle is:
66

7-
* Supported by [ONGR.io](http://ongr.io) development team.
8-
* Uses the official [elasticsearch-php](https://github.com/elastic/elasticsearch-php) client.
7+
* Supported by [ONGR.io][2] development team.
8+
* Uses the official [elasticsearch-php][3] client.
99
* Ensures full integration with Symfony framework.
1010

1111
Technical goodies:
@@ -18,7 +18,7 @@ Technical goodies:
1818
* Profiler that integrates in the Symfony debug bar and shows all executed queries.
1919
* Designed in an extensible way for all your custom needs.
2020

21-
If you need any help, [stack overflow](http://stackoverflow.com/questions/tagged/ongr)
21+
If you need any help, [stack overflow][4]
2222
is the preferred and recommended way to ask questions about ONGR bundles and libraries.
2323

2424

@@ -40,25 +40,35 @@ is the preferred and recommended way to ask questions about ONGR bundles and lib
4040

4141
## Documentation
4242

43-
The online documentation of the bundle can be found in [http://docs.ongr.io](http://docs.ongr.io/ElasticsearchBundle).
43+
The online documentation of the bundle can be found in [http://docs.ongr.io][5].
4444
Docs source is stored within the repo under `Resources/doc/`, so if you see a typo or problem, please submit a PR to fix it!
4545

46-
For contribution to the documentation you can find it in the [contribute](Resources/doc/contribute.md) topic.
46+
For contribution to the documentation you can find it in the [contribute][6] topic.
4747

48+
## FAQ
49+
* [Mapping explained][7]
50+
* [Using Meta-Fields][8]
51+
* [Configuration][9]
52+
* [Console commands][10]
53+
* [How to do a simple CRUD actions][11]
54+
* [Quick find functions][12]
55+
* [How to search the index][13]
56+
* [Scan through the index][14]
57+
* [Parsing the results][15]
4858

4959
## Setup the bundle
5060

5161
#### Step 1: Install Elasticsearch bundle
5262

53-
Elasticsearch bundle is installed using [Composer](https://getcomposer.org).
63+
Elasticsearch bundle is installed using [Composer][16].
5464

5565
```bash
5666
php composer.phar require ongr/elasticsearch-bundle "~2.0"
5767

5868
```
5969

6070
> Instructions for installing and deploying Elasticsearch can be found in
61-
[Elasticsearch installation page](https://www.elastic.co/downloads/elasticsearch).
71+
[Elasticsearch installation page][17].
6272

6373
Enable Elasticsearch bundle in your AppKernel:
6474

@@ -95,10 +105,10 @@ ongr_elasticsearch:
95105

96106
```
97107

98-
> This is the very basic example only, for more information, please take a look at the [configuration](Resources/doc/configuration.md) chapter.
108+
> This is the very basic example only, for more information, please take a look at the [configuration][9] chapter.
99109
100110
In this particular example there are 2 things you should know. The index name in the index node and the mappings.
101-
Mappings is the place where your documents are stored (more info at [the mapping chapter](Resources/doc/mapping.md)).
111+
Mappings is the place where your documents are stored (more info at [the mapping chapter][7]).
102112

103113

104114
#### Step 3: Define your Elasticsearch types as `Document` objects
@@ -135,7 +145,7 @@ class Customer
135145
```
136146

137147
> This is the basic example only, for more information about mapping, please take a look
138-
at the [the mapping chapter](http://docs.ongr.io/ElasticsearchBundle/mapping).
148+
at the [the mapping chapter][7].
139149

140150

141151
#### Step 4: Create index and mappings
@@ -148,17 +158,42 @@ bin/console ongr:es:index:create
148158

149159
```
150160

151-
> More info about the rest of the commands can be found in the [commands chapter](http://docs.ongr.io/ElasticsearchBundle/commands).
161+
> More info about the rest of the commands can be found in the [commands chapter][10].
152162
153163

154164
#### Step 5: Enjoy with the Elasticsearch
155165

156-
We advise to take a look at the [mapping chapter](http://docs.ongr.io/ElasticsearchBundle/mapping) to configure the index.
157-
Search documentation for the Elasticsearch bundle is [available here](http://docs.ongr.io/ElasticsearchBundle/search).
158-
And finally it's up to you what amazing things you are going to create :sunglasses: .
166+
We advise to take a look at the [mapping chapter][7] to configure the index.
167+
Search documentation for the Elasticsearch bundle is [available here][13].
168+
And finally it's up to you what amazing things you are going to create :sunglasses: .
159169

170+
## Troubleshooting
171+
* [How to upgrade from the older versions?][18]
172+
* [How to overwrite some parts of the bundle?][19]
160173

161174
## License
162175

163176
This bundle is licensed under the MIT license. Please, see the complete license
164177
in the bundle `LICENSE` file.
178+
179+
180+
181+
[1]: https://www.elastic.co/products/elasticsearch
182+
[2]: http://ongr.io
183+
[3]: https://github.com/elastic/elasticsearch-php
184+
[4]: http://stackoverflow.com/questions/tagged/ongr
185+
[5]: http://docs.ongr.io/ElasticsearchBundle
186+
[6]: http://docs.ongr.io/common/Contributing
187+
[7]: http://docs.ongr.io/ElasticsearchBundle/mapping
188+
[8]: http://docs.ongr.io/ElasticsearchBundle/meta_fields
189+
[9]: http://docs.ongr.io/ElasticsearchBundle/configuration
190+
[10]: http://docs.ongr.io/ElasticsearchBundle/commands
191+
[11]: http://docs.ongr.io/ElasticsearchBundle/crud
192+
[12]: http://docs.ongr.io/ElasticsearchBundle/find_functions
193+
[13]: http://docs.ongr.io/ElasticsearchBundle/search
194+
[14]: http://docs.ongr.io/ElasticsearchBundle/scan
195+
[15]: http://docs.ongr.io/ElasticsearchBundle/results_parsing
196+
[16]: https://getcomposer.org
197+
[17]: https://www.elastic.co/downloads/elasticsearch
198+
[18]: http://docs.ongr.io/ElasticsearchBundle/upgrade
199+
[19]: http://docs.ongr.io/ElasticsearchBundle/overwriting_bundle

0 commit comments

Comments
 (0)