updated the docs

Mantas Marcinkevicius · Mantas Marcinkevicius · commit 23acabc38950 · 2019-09-27T09:41:06.000+03:00
diff --git a/README.md b/README.md
@@ -71,17 +71,13 @@ php composer.phar require ongr/elasticsearch-bundle "~6.0"
 Enable ElasticSearch bundle in your AppKernel:
 
 ```php
-// app/AppKernel.php
+<?php
+// config/bundles.php
 
-public function registerBundles()
-{
-    $bundles = [
-        // ...
-        new ONGR\ElasticsearchBundle\ONGRElasticsearchBundle(),
-    ];
-    
+return [
     // ...
-}
+    ONGR\ElasticsearchBundle\ONGRElasticsearchBundle::class => ['all' => true],
+];
 
 ```
 
@@ -91,7 +87,7 @@ Add minimal configuration for Elasticsearch bundle.
 
 ```yaml
 
-# app/config/config.yml
+# config/packages/ongr_elasticsearch.yaml
 ongr_elasticsearch:
     analysis:
         filter:
@@ -106,6 +102,9 @@ ongr_elasticsearch:
                 filter:
                     - lowercase
                     - edge_ngram_filter #that's the filter defined earlier
+    indexes:
+        App\Document\Product:
+            hosts: [elasticsearch:9200] # optional, the default is 127.0.0.1:9200
 
 ```
 
@@ -116,15 +115,15 @@ ongr_elasticsearch:
 This bundle uses objects to represent Elasticsearch documents. Lets create the `Product` class for the `products` index.
 
 ```php
-// src/AppBundle/Document/Customer.php
+// src/Document/Product.php
 
-namespace AppBundle\Document;
+namespace App\Document;
 
 use ONGR\ElasticsearchBundle\Annotation as ES;
 
 /**
  * //alias and default parameters in the annotation are optional. 
- * @ES\Document(alias="products", default=true)
+ * @ES\Index(alias="products", default=true)
  */
 class Product
 {
@@ -169,6 +168,11 @@ Now the `products` index should be created with fields from your document.
 Full documentation for the Elasticsearch bundle is [available here][4].
 I hope you will create amazing things with it :sunglasses: .
 
+> Please note that the updating process of the documentation of the bundle to 6.0
+>is still under way. Read the [configuration][7] and [crud][9] sections that are 
+>already updated and will allow you to have the basic functions of the bundle. We
+>will update the rest of the documentation as soon as possible
+
 ## Troubleshooting
 * [How to upgrade from the older versions?][15]
 * [How to overwrite some parts of the bundle?][16]
@@ -194,3 +198,4 @@ in the bundle `LICENSE` file.
 [14]: https://www.elastic.co/downloads/elasticsearch
 [15]: http://docs.ongr.io/ElasticsearchBundle/upgrade
 [16]: http://docs.ongr.io/ElasticsearchBundle/overwriting_bundle
+
diff --git a/Resources/doc/configuration.md b/Resources/doc/configuration.md
@@ -5,40 +5,32 @@ Here's an example of full configuration with all possible options including defa
 ```yml
 ongr_elasticsearch:
     analysis:
-      analyzer:
-          pathAnalyzer:
-              type: custom
-              tokenizer: pathTokenizer
-      tokenizer:
-          pathTokenizer:
-              type : path_hierarchy
-              buffer_size: 2024
-              skip: 0
-              delimiter: /
-      filter:
-          incremental_filter:
-              type: edge_ngram
-              min_gram: 1
-              max_gram: 20
-    managers:
-        default:
-            index: 
-                hosts:
-                    - 127.0.0.1:9200
-                index_name: ongr-default
-                settings:
-                    refresh_interval: -1
-                    number_of_replicas: 0
-                    number_of_shards: 1
-            logger: true #default %kernel.debug%
-            mappings:
-                - AcmeBarBundle #Scans all bundle documents
-        custom:
-            index: 
-                hosts:
-                    - 10.0.0.1:9200 #default 127.0.0.1:9200
-                index_name: ongr-custom
-                mappings:
-                    AcmeBundle:
-                        document_dir: Document
+        analyzer:
+            pathAnalyzer:
+                type: custom
+                tokenizer: pathTokenizer
+        tokenizer:
+            pathTokenizer:
+                type : path_hierarchy
+                buffer_size: 2024
+                skip: 0
+                delimiter: /
+        filter:
+            incremental_filter:
+                type: edge_ngram
+                min_gram: 1
+                max_gram: 20
+    source_directory: /src/AppBundle
+    logger: false 
+    profiler: true
+    cache: true
+    indexes: # overrides any index related config from anotations
+        App\Document\Page:
+            default: true
+            hosts:
+                - 'elasticsearch:9200'
+            settings:
+                number_of_replicas: 2
+                number_of_shards: 3
+            type: page # for 5.x ES compatibility
 ```
diff --git a/Resources/doc/crud.md b/Resources/doc/crud.md
@@ -5,75 +5,52 @@
 For all steps below we assume that there is an `AppBundle` with the `Content` document.
 
 ```php
-// src/AppBundle/Document/Content.php
+// src/Document/Product.php
 
-namespace AppBundle\Document;
+namespace App\Document;
 
 use ONGR\ElasticsearchBundle\Annotation as ES;
 
 /**
- * @ES\Document(type="content")
+ * //alias and default parameters in the annotation are optional. 
+ * @ES\Index(alias="content", default=true)
  */
 class Content
 {
     /**
-     * @var string
-     *
      * @ES\Id()
      */
     public $id;
 
     /**
-     * @ES\Property(type="keyword")
+     * @ES\Property(type="text")
      */
     public $title;
 }
 ```
 
-## Manager
-
-Elasticsearch bundle provides managers able to handle several indexes to communicate with elasticsearch.
-
-Once you define managers in your `config.yml` file, you can use them in controllers and grab them from DI container via `es.manager` (alias for `es.manager.default`). If you define more than one manager, for example called `foo`, then it will be accessible via `es.manager.foo`.
-
-```php
-
-$manager = $this->get('es.manager');
-
-```
+> Important notice: you don't need your properties to be public, but they will
+>need to have getters and setters otherwise.
 
-## Repositories
-
-In addition manager provides repository access, which enables direct access to the elasticsearch type.  
-Repository represents a document. Whenever you need to do any action with a repository, you can access 
-it like this:
-
-```php
-
-$manager = $this->get('es.manager');
-$repo = $manager->getRepository('AppBundle:Content');
+## Manager
 
-```
+Elasticsearch bundle provides managers called indexes to able to handle several ES indexes 
+for communication with elasticsearch.
 
-Alternatively:
+Each index will have its dedicated manager that can be reached via service container by the 
+name of the namespace of the Document class that represents the index in question. So in our
+case: 
 
 ```php
 
-$repo = $this->get('es.manager.default.content');
+$index = $container->get(Content::class);
 
 ```
 
-`default` - represents a manager name and `content` an elasticsearch type name.
+> Important: The old implementation was to have manager and repositories dedicated
+>for each document type. In 6.0 the functionalities of these services were merged
+>into the index service for each document.
 
-> Important: Document with the certain type name has to be mapped in the manager.
-
-You can also get a manager from the repo instance:
-
-```php
-
-$manager = $repo->getManager();
-
-```
 
 ## Create a document
 
@@ -82,19 +59,19 @@ $manager = $repo->getManager();
 $content = new Content();
 $content->id = 5; // Optional, if not set, elasticsearch will set a random.
 $content->title = 'Acme title';
-$manager->persist($content);
-$manager->commit();
+$index->persist($content);
+$index->commit();
 
 ```
 
 ## Update a document
 
 ```php
 
-$content = $manager->find('AppBundle:Content', 5);
+$content = $index->find(5); // Alternatively $index->findBy(['title' => 'acme title']);
 $content->title = 'changed Acme title';
-$manager->persist($content);
-$manager->commit();
+$index->persist($content);
+$index->commit();
 
 ```
 
@@ -106,8 +83,8 @@ To update a field you need to know the document `ID` and fields to update. Here'
 
 ```php
 
-$repo = $this->get('es.manager.default.content');
-$repo->update(1, ['title' => 'new title']);
+$index = $this->get(Content::class);
+$index->update(1, ['title' => 'new title']);
 
 ```
 
@@ -116,22 +93,23 @@ You can also update fields with script operation, lets say, you want to do some
 
 ```php
 
-$repo = $this->get('es.manager.default.product');
-$repo->update(1, [], 'ctx._source.stock+=1');
+$index = $this->get(Content::class);
+$index->update(1, [], 'ctx._source.stock+=1');
 
 ```
 > Important: when using script update fields cannot be updated, leave empty array, otherwise you will get 400 exception.
 
 `ctx._source` comes from groovy scripting and you have to enable it in elasticsearch config with: `script.groovy.sandbox.enabled: false`
 
 
-In addition you also can get other document fields with the response of update, lets say we also want a content field and a new title, so just add them separated by a comma:
+In addition you also can get other document fields with the response of update, 
+lets say we also want a content field and a new title, so just add them separated by a comma:
 
 
 ```php
 
-$repo = $this->get('es.manager.default.content');
-$response = $repo->update(1, ['title' => 'new title'], null, ['fields' => 'title,content']);
+$index = $this->get(Content::class);
+$index = $repo->update(1, ['title' => 'new title'], null, ['fields' => 'title,content']);
 
 ```
 
@@ -141,15 +119,7 @@ $response = $repo->update(1, ['title' => 'new title'], null, ['fields' => 'title
 Document removal can be performed similarly to create or update action:
 
 ```php
-$manager->remove($content);
-$manager->commit();
-```
-
-Alternatively you can remove document by ID (requires to have repository service):
-
-```php
-
 $repo = $this->get('es.manager.default.content');
 $content = $repo->remove(5);
-
 ```
+
