[doc] Updated changelog

Author: Valentin Clavreul

Documentation/100-roadmap.md renamed to Documentation/changelog/CHANGELOG-2.0-1.1.md

@@ -30,6 +30,16 @@ MappingTransformer
 
 * The option "ignore_extra" is renamed to "keep_input".
 
+Other
+-----
+
+* Fixed issues with blocking tasks
+* Removed deprecated methods
+* added input/output in process manager (may allow a start_process_task)
+
+New issues :
+* Error workflow
+
 Planned (v2+)
 ============
 

Documentation/changelog/CHANGELOG-3.1.md

@@ -1,8 +1,19 @@
-Changelog v3.0 => v3.1
-======================
+Release v3.1
+============
 
-Features
---------
+v3.1-dev
+------
+
+### Features
+
+### Fixes
+
+### BC breaks
+
+v3.1.0
+------
+
+### Features
 
 * [GITHUB-83](https://github.com/cleverage/process-bundle/issues/83): added [events](../04-advanced_workflow.md#events) 
 around process execution
@@ -11,11 +22,11 @@ around process execution
 * [GITHUB-107](https://github.com/cleverage/process-bundle/issues/107): allow to use directly a string in task `outputs`
 and `errors` configurations
 
-Fixes
------
+### Fixes
+
+* [GITHUB-99](https://github.com/cleverage/process-bundle/issues/99): transformer exception message improvements
 
-BC breaks
----------
+### BC breaks
 
 * [GIHTUB-82](https://github.com/cleverage/process-bundle/issues/82): the `default_error_strategy` is now mandatory. 
 If you have any doubt, you can use `default_error_strategy: skip` to keep previous behavior. 

README.md

@@ -62,149 +62,6 @@ Basically, it will greatly ease the configuration of import and exports but can
     - [Generic transformers definition](Documentation/reference/03-generic_transformers_definition.md)
 - Examples
     - [Simple ETL]
-- [Roadmap and versions](Documentation/100-roadmap.md)
-
-
--------
-
-_obsolete documentation_
-
-## Configuration reference
-
-### Defining processes
-```yml
-clever_age_process:
-    configurations:
-        <process_code>:
-            options: ~ # Global options for the whole process, not currently used
-            entry_point: <task_code> # Code of the first task to execute
-            tasks: # See the next chapter
-                <task_code>:
-                    # You can use two syntax for service declaration
-                    service: '@<reference of the service>'
-                    
-                    # Or, alternatively, if you don't want to declare unecessary services if no argument is needed to construct this task
-                    service: MyNamespace\FooBarBundle\Task\MyTask
-                    
-                    # In both cases the service/class must implements the TaskInterface
-                    
-                    # Options to pass to the task, see each task for more information
-                    options: {}
-                    
-                    # List of the tasks to pass the output to
-                    outputs: [<other_task_code>, ...]
-                    
-                    # Other possible values are: 'stop' and 'continue'
-                    error_strategy: skip
-                    
-                    # Logs any errors encountered
-                    log_level: critical
-
-                # More tasks
-```
-Note that orphan tasks will be reported as errors before the process starts
-
-### Existing tasks
-
-#### StatCounterTask
-Accepts an array or an object as an input and sets values before returning it as the output.
-At the end of the process, during the finalize(), it will log the number of item processed.
-```yml
-<task_code>:
-    service: '@CleverAge\ProcessBundle\Task\Reporting\StatCounterTask'
-```
-No supported options, no output.
-
-#### ValidatorTask
-Validate data from the input and pass it to the output
-```yml
-<task_code>:
-    service: '@CleverAge\ProcessBundle\Task\Validation\ValidatorTask'
-    outputs: [<task_code>] # Array of tasks accepting the same data than the input
-```
-
-## Creating a custom task
-
-### Creating the class
-
-```php
-<?php
-
-namespace MyNamespace\FooBarBundle\Task;
-
-use CleverAge\ProcessBundle\Model\ProcessState;
-use CleverAge\ProcessBundle\Model\TaskInterface;
-
-class MyTask implements TaskInterface
-{
-    /**
-     * @param ProcessState $state
-     */
-    public function execute(ProcessState $state)
-    {
-        // Do stuff
-    }
-}
-```
-
-### Configuring the service
-
-```yml
-services:
-    my_namespace.task.task_code:
-        class: MyNamespace\FooBarBundle\Task\MyTask
-        shared: false
-```
-Unless you want to share the same service between multiple tasks with the same service reference, we strongly recommend
-to configure your tasks services as ```shared: false```.
-
-## Example
-
-Basic export to CSV process
-
-```yml
-clever_age_process:
-    configurations:
-        data_export:
-            entry_point: read
-            tasks:
-                read:
-                    service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineReaderTask'
-                    options:
-                        class_name: MyNamespace\FooBarBundle\Entity\Data
-                    outputs: [normalize]
-
-                normalize:
-                    service: '@CleverAge\ProcessBundle\Task\Serialization\NormalizerTask'
-                    options:
-                        format: csv
-                    outputs: [write]
-
-                write:
-                    service: '@CleverAge\ProcessBundle\Task\File\Csv\CsvWriterTask'
-                    options:
-                        file_path: '%kernel.root_dir%/../var/data/export/data.csv'
-```
-
-## Known issues
-
-For now there are some issue with BlockingTask in multi-branch workflow
-
-* An IterableTask cannot have 2 children BlockingTask : only the last BlockingTask will be proceeded
-* A BlockingTask will not be proceeded if it has not a direct ancestor IterableTask 
-* A BlockingTask will be proceeded as much as there is direct IterableTask ancestors
-
-If you want to avoid any problem, use BlockingTask only in a one-branch workflow, with only one preceding IterableTask :
-
-* Task -> Iterable -> Task -> Task -> Blocking -> Task
-
-## Release notes
-
-### v1.1
-
-* Fixed issues with blocking tasks
-* Removed deprecated methods [...]
-* added input/output in process manager (may allow a start_process_task)
-
-New issues :
-* Error workflow
+- Changelog
+    - [v3.1](Documentation/changelog/CHANGELOG-3.1.md)
+    - [Older versions](Documentation/changelog/CHANGELOG-2.0-1.1.md)