add some docs

dachcom-digital · Jun 23, 2019 · 0bf846a · 0bf846a
1 parent 7f67b72
commit 0bf846a
Show file tree

Hide file tree

Showing 2 changed files with 164 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Pimcore 5 - Dynamic Search
+# Pimcore 5/6 - Dynamic Search
 
 ![Dynamic Search Schema](https://user-images.githubusercontent.com/700119/59977691-d9ba9580-95d4-11e9-8d25-c87308e5e48c.png)
 
@@ -17,8 +17,8 @@ This bundle has no stable release yet and is allowed to introduce major changes
 The Dynamic Search Bundle allows you to redefine your search strategy. It's based on several data- and index providers.
 
 ### Data Provider
-- [WebCrawler (Spider)](https://github.com/dachcom-digital/pimcore-dynamic-search-data-provider-crawler)
-- [Trinity Data (Pimcore: Object, Asset, Document)](https://github.com/dachcom-digital/pimcore-dynamic-search-data-provider-trinity)
+- [WebCrawler](https://github.com/dachcom-digital/pimcore-dynamic-search-data-provider-crawler) (Spider)
+- [Trinity Data](https://github.com/dachcom-digital/pimcore-dynamic-search-data-provider-trinity) (Pimcore: Object, Asset, Document)
 
 ### Index Provider
 - [Lucene Search](https://github.com/dachcom-digital/pimcore-dynamic-search-index-provider-lucene)
@@ -52,6 +52,9 @@ After you have updated the Dynamic Search Bundle via composer:
 Does actually the same as the update command and preferred in CI-Workflow:
 - Execute: `$ bin/console pimcore:migrations:migrate -b DynamicSearchBundle`
 
+## Further Information
+- [Example Setup](docs/0_ExampleSetup.md)
+
 ## Copyright and License
 Copyright: [DACHCOM.DIGITAL](http://dachcom-digital.com)  
 For licensing details please visit [LICENSE.md](LICENSE.md)

diff --git a/docs/0_ExampleSetup.md b/docs/0_ExampleSetup.md
@@ -0,0 +1,158 @@
+# Example Setup
+
+### composer.json
+
+```json
+"require" : {
+    "dachcom-digital/dynamic-search": "~0.1.0",
+    "dachcom-digital/dynamic-search-data-provider-crawler": "~0.1.0",
+    "dachcom-digital/dynamic-search-data-provider-trinity": "~0.1.0",
+    "dachcom-digital/dynamic-search-index-provider-lucene": "~0.1.0",
+}
+```
+
+### app/config/config.yml
+
+```yaml
+dynamic_search:
+
+    context:
+
+        ecommerce:
+
+            index_provider:
+                service: 'lucene'
+                options:
+                    database_name: 'ecommerce'
+
+            data_provider:
+                service: 'trinityData'
+                options:
+                    index_object: true
+                    object_class_names:
+                        - TestClass
+                    index_document: true
+                    index_asset: true
+
+            output_channels:
+                autocomplete:
+                    service: 'lucene'
+                suggestions:
+                    service: 'lucene'
+                    options:
+                        restrict_search_fields:
+                            - 'sku'
+                search:
+                    service: 'lucene'
+                    options:
+                        max_per_page: 4
+
+            data_transformer:
+
+                document:
+                    id:
+                        field_transformer: 'element_id_extractor'
+
+                fields:
+
+                    sku:
+                        index_type: 'keyword'
+                        field_transformer: 'object_getter_extractor'
+                        field_transformer_options:
+                            argument: 'getSku'
+
+                    title:
+                        index_type: 'text'
+                        field_transformer: 'object_getter_extractor'
+                        field_transformer_options:
+                            argument: 'getTitle'
+
+                    image:
+                        index_type: 'text'
+                        field_transformer: 'object_getter_extractor'
+                        field_transformer_options:
+                            argument: 'getImage'
+
+        default:
+
+            index_provider:
+                service: 'lucene'
+                options:
+                    database_name: 'default'
+
+            data_provider:
+                service: 'webCrawler'
+                options:
+                    seed: 'http://dev-site.test/de'
+                    valid_links:
+                        - '@^http://dev-site.test.*@i'
+                    user_invalid_links:
+                        - '@^http://dev-site.test\/members.*@i'
+
+            output_channels:
+                autocomplete:
+                    service: 'lucene'
+                    runtime_options_provider: 'my-special-runtime-options-provider'
+                suggestions:
+                    service: 'lucene'
+                    options:
+                        restrict_search_fields:
+                            - 'main_headline'
+                search:
+                    service: 'lucene'
+                    options:
+                        max_per_page: 4
+
+            data_transformer:
+
+                document:
+                    id:
+                        field_transformer: 'resource_document_id_extractor'
+                    boost:
+                        field_transformer: 'resource_meta_extractor'
+                        field_transformer_options:
+                            name: 'boost'
+
+                fields:
+
+                    uri:
+                        index_type: 'keyword'
+                        field_transformer: 'resource_uri_extractor'
+
+                    host:
+                        index_type: 'keyword'
+                        field_transformer: 'resource_host_extractor'
+
+                    language:
+                        index_type: 'keyword'
+                        field_transformer: 'resource_language_extractor'
+
+                    title:
+                        index_type: 'text'
+                        field_transformer: 'resource_title_extractor'
+
+                    main_headline:
+                        index_type: 'text'
+                        field_transformer: 'resource_html_tag_content_extractor'
+                        field_transformer_options:
+                            tag: 'h1'
+                            return_multiple: false
+
+                    meta_description:
+                        index_type: 'text'
+                        field_transformer: 'resource_meta_extractor'
+                        field_transformer_options:
+                            name: 'description'
+
+                    content:
+                        index_type: 'text'
+                        field_transformer: 'resource_text_extractor'
+                        field_transformer_options:
+                            content_start_indicator: '<!-- main-content -->'
+                            content_end_indicator: '<!-- /main-content -->'
+                            # content_exclude_start_indicator: ''
+                            # content_exclude_end_indicator: ''
+                        output_channel:
+                            visibility:
+                                suggestions: false
+```