Merge pull request #1356 from Tobion/dependencies-doc

show overview of versions and dependencies

Author: XWB

README.md

@@ -1,7 +1,7 @@
 FOSElasticaBundle
 =================
 
-This bundle provides integration with [ElasticSearch](http://www.elasticsearch.org) and [Elastica](https://github.com/ruflin/Elastica) with
+This bundle provides integration with [Elasticsearch](http://www.elasticsearch.org) and [Elastica](https://github.com/ruflin/Elastica) with
 Symfony. Features include:
 
 - Integrates the Elastica library into a Symfony environment
@@ -14,17 +14,27 @@ Symfony. Features include:
 Documentation
 -------------
 
-Documentation for FOSElasticaBundle is in `doc/index.md`
-
-[Read the documentation for 5.0.x](https://github.com/FriendsOfSymfony/FOSElasticaBundle/blob/master/doc/index.md)
-
-[Read the documentation for 4.0.x](https://github.com/FriendsOfSymfony/FOSElasticaBundle/blob/4.0.x/Resources/doc/index.md)
+Documentation for FOSElasticaBundle is in [`doc/index.md`](doc/index.md)
 
 Installation
 ------------
 
 Installation instructions can be found in the [documentation](doc/setup.md)
 
+Versions & Dependencies
+-----------------------
+
+Version 5 of the FOSElasticaBundle is compatible with Elasticsearch 5 and 6. It requires Symfony 3 or 4. When using
+Symfony Flex there is also a [recipe to ease the setup](https://github.com/symfony/recipes-contrib/tree/master/friendsofsymfony/elastica-bundle/5.0).
+Earlier versions of the FOSElasticaBundle are not maintained anymore and only work with older versions of the dependencies.
+The following table shows the compatibilities of different versions of the bundle.
+
+| FOSElasticaBundle                                                                       | Elastica | Elasticsearch | Symfony    | PHP   |
+| --------------------------------------------------------------------------------------- | ---------| ------------- | ---------- | ----- |
+| [5.x](https://github.com/FriendsOfSymfony/FOSElasticaBundle/tree/master)                | ^5.2\|^6 | 5.\*\|6.\*    | ^3.2\|^4   | >=5.6 |
+| [4.x](https://github.com/FriendsOfSymfony/FOSElasticaBundle/tree/4.x) (unmaintained)    | 3.2.\*   | 2.\*          | ^2.8\|^3.2 | >=5.5 |
+| [3.2.x](https://github.com/FriendsOfSymfony/FOSElasticaBundle/tree/3.2.x) (unmaintained)| ^2.1     | 1.\*          | ^2.3\|^3   | >=5.3 |
+
 License
 -------
 

doc/cookbook/attachments.md

@@ -6,7 +6,7 @@ This is just a quick overview of how to handle attachment mappings, searching, a
 Mappings
 -----------------------------
 
-You can set up the FOSElasticaBundle to use attachments in the mappings. An overview of the ElasticSearch attachment plugin
+You can set up the FOSElasticaBundle to use attachments in the mappings. An overview of the Elasticsearch attachment plugin
 can be viewed here - https://github.com/elastic/elasticsearch-mapper-attachments. Installation instructions can be found
 on the github page. If you want to highlight content from the document, then you will need to add `"store": true` AND
 `"term_vector":"with_positions_offsets"` to the attachment field.

doc/cookbook/doctrine-queue-listener.md

@@ -2,7 +2,7 @@
 
 FOSElasticaBundle subscribes on Doctrine events, such as insert, update, remove to adjust the index accordingly.
 The listener might start consuming more and more resources, most importantly time of http response.
-Or, Sometimes it fails, bringing the whole your app down too, because of ElasticSearch server is out of order or some bug in the code.
+Or, Sometimes it fails, bringing the whole your app down too, because of Elasticsearch server is out of order or some bug in the code.
 Keep reading if you want to improve http response time or strive for better fault tolerance.
 
 Instead of doing everything in one single process the listener just sends a message to a worker (via [message queue](https://en.wikipedia.org/wiki/Message_queue)).

doc/setup.md

@@ -64,7 +64,7 @@ fos_elastica:
 In this example, an Elastica index (an instance of `Elastica\Index`) is available as a
 service with the key `fos_elastica.index.app`.
 
-You may want the index `app` to be named something else on ElasticSearch depending on
+You may want the index `app` to be named something else on Elasticsearch depending on
 if your application is running in a different env or other conditions that suit your
 application. To set your customer index to a name that depends on the environment of your
 Symfony application, use the example below:
@@ -77,7 +77,7 @@ fos_elastica:
             index_name: app_%kernel.environment%
 ```
 
-In this case, the service `fos_elastica.index.app` will relate to an ElasticSearch index
+In this case, the service `fos_elastica.index.app` will relate to an Elasticsearch index
 that varies depending on your kernel's environment. For example, in dev it will relate to
 `app_dev`.
 

doc/types.md

@@ -338,7 +338,7 @@ only fire after the `kernel.terminate` and `console.terminate` events.
 Logging Errors
 --------------
 
-By default FOSElasticaBundle will not catch errors thrown by Elastica/ElasticSearch.
+By default FOSElasticaBundle will not catch errors thrown by Elastica/Elasticsearch.
 Configure a logger per listener if you would rather catch and log these.
 
 ```yaml