Update doc

Move from rst to md

CONTRIBUTING.md

@@ -30,7 +30,7 @@ Good bug reports are extremely helpful - thank you!
 
 Guidelines for bug reports:
 
-1. **Use the GitHub issue search** — check if the issue has already been
+1. **[Use the GitHub issue search](https://github.com/Cocolabs-SAS/cocorico/issues)** — check if the issue has already been
    reported.
 
 2. **Check if the issue has been fixed** — try to reproduce it using the

README.md

@@ -1,3 +1,7 @@
+<h1 align="center">
+    <img src="http://docs.cocorico.io/images/logo_cocorico.png" alt="Cocorico"/>
+</h1>
+
 # Cocorico
 
 [![Build Status](https://secure.travis-ci.org/Cocolabs-SAS/cocorico.svg)](http://travis-ci.org/Cocolabs-SAS/cocorico)
@@ -6,11 +10,15 @@
 
 Cocorico is an open source platform to create collaborative consumption marketplaces - [http://www.cocolabs.io](http://www.cocolabs.io)
 
-![preview](doc/img/preview1.png)
+A demo is available at [http://demo.cocorico.io](http://demo.cocorico.io).
 
 ## Installation
 
-Please [read this documentation](doc/installation.md)
+Please [read installation instructions](doc/installation.md)
+
+## Documentation
+
+Documentation is available [here](doc/index.md)
 
 ## Contribute
 

ROADMAP.md

@@ -2,44 +2,72 @@
 
 ## [Unreleased]
 
-### Change createdAt, and updatedAt field names to created_at and updated_at according to doctrine.orm.naming_strategy
-
-### Update PHP to 5.6
+### Fix remaining SF 2.x deprecations
 
-    * Last LTS version : See http://php.net/supported-versions.php
-    * Will be useful for Symfony 3 upgrade and depreciation resolution
+* Accessing form type by its fully-qualified type class name instead string name
 
-### Fix remaining SF 2.x deprecations
+* Passing type instances to FormBuilder::add() by its fully-qualified type class name instead string name
 
-    * Accessing form type by its fully-qualified type class name instead string name
-    * Passing type instances to FormBuilder::add() by its fully-qualified type class name instead string name
-    * Use "constraints" with a Valid constraint instead of "cascade_validation" in form types.
-    * Use form option "entry_type" instead of "type"
-    * Replace "empty_value" option in types "choice", "date", ...by "placeholder". 
-        Todo when this issue https://github.com/schmittjoh/JMSTranslationBundle/issues/228 will be resolved 
+* Use "constraints" with a Valid constraint instead of "cascade_validation" in form types.
+
+* Use form option "entry_type" instead of "type"
+
+* Replace "empty_value" option in types "choice", "date", ...by "placeholder". 
+    To do when this issue https://github.com/schmittjoh/JMSTranslationBundle/issues/228 will be resolved 
+
+
+### Use "php-http/httplug" instead of abandonned "egeloen/http-adapter" package in CocoricoGeoBundle
+
+* Wait merge of this PR https://github.com/geocoder-php/Geocoder/pull/487
+
+
+### Upgrade Symfony 3.4
 
 ### Fix BDD tests
 
-### Use "php-http/httplug" instead abandonned "egeloen/http-adapter" package in CocoricoGeoBundle
-    * Wait merge of this PR https://github.com/geocoder-php/Geocoder/pull/487
+### Fix db fields case  
+
+Fix case of createdAt, and updatedAt field names to created_at and updated_at according to doctrine.orm.naming_strategy
 
 ### Architecture evolution
 
-    * Decoupling
-    * Modularity
-    * ...
+* Decoupling
+* Externalization
+* Overridability
+* Use SF Workflow component (SF >= 3.2) or fduch/workflow-bundle (SF >=2.3)
+* APIfication
+* Micro services
+* Travis
+
+### Upgrade to Symfony 4
+
+### Add translator Providers (Google)
 
 ### Fix bug:
 
-    * Double click on save availabilities pop-in
-    * Wait merge of WebProfilerBundle https://github.com/symfony/symfony/pull/18413
+* Double click on save availabilities pop-in
+
+* Wait merge of WebProfilerBundle https://github.com/symfony/symfony/pull/18413
+
 
 
+## [0.4.0] - 2016-12-02
+
+### Update PHP to 5.6
+
+* Last LTS version : See http://php.net/supported-versions.php
+
+* Will be useful for Symfony 3 upgrade and depreciation resolution
+
+
 ## [0.2.0] - 2016-04-06
 
 ### Update Symfony from 2.5 to 2.8 (see https://github.com/symfony/symfony/blob/2.8/UPGRADE-2.8.md)
 
-    * Update Symfony package to its last LTS version (2.8).
-    * Resolve depreciated warnings
+* Update Symfony package to its last LTS version (2.8).### Update PHP to 5.6                                                     
+    * Last LTS version : See http://php.net/supported-versions.php
+    * Will be useful for Symfony 3 upgrade and depreciation resolution
+
+* Resolve depreciated warnings
 
 ### Update dependencies

doc/breadcrumbs.rst → doc/breadcrumbs.md

@@ -1,5 +1,4 @@
-Breadcrumbs
-===========
+# Breadcrumbs
 
 You need to add your breadcrumbs in `src/Cocorico/CoreBundle/Resources/content/breadcrumbs.yml`
 

doc/crons.rst → doc/crons.md

@@ -1,11 +1,9 @@
-Crons
-=====
+# Crons
 
 Add this commands to your cron tab and don't forget to set the same PHP timezone "UTC" 
 in  the php.ini file of php and php-cli.
 
-Required
---------
+## Required
 
 1. Currencies update:
 
@@ -36,8 +34,7 @@ Required
     `0 0 27 * * php <path-to-your-app>app/console cocorico:listings:alertUpdateCalendars --env=dev`
 
 
-Optionals
----------
+## Optionals
 
 1. Listings platform notation computing (Optional. ListingSearchBundle must be enabled):
 

doc/deployment.md

@@ -0,0 +1,49 @@
+# Deployment
+
+Deployment use https://github.com/hpatoio/DeployBundle
+
+1. Configuration
+
+    * Parameters:
+        Set in your parameters.yml the following parameters:
+
+            deploy_host: cocorico.prod
+            deploy_dir: /var/www/cocorico.prod/Symfony
+            deploy_user: cocorico
+
+    * php.ini:
+        Add this to your php.ini:
+
+            extension=mongodb.so
+
+2. Deploy
+
+    * Dry-Run:
+
+            php app/console project:deploy prod
+
+    * Real:
+
+            php app/console project:deploy --go prod
+
+     For more informations see https://github.com/hpatoio/DeployBundle
+
+3. Post deployment tasks
+
+    * Install/Update Vendors:
+
+            export SYMFONY_ENV=prod && php composer.phar install --no-dev --prefer-dist --optimize-autoloader
+            php composer.phar dump-autoload --optimize
+
+    * Clear Symfony Cache:
+
+            php app/console cache:clear --env=prod --no-debug
+
+    * Dump Assetic Assets:
+
+            php app/console assetic:dump --env=prod --no-debug
+
+4. Add crons
+
+    See [crons documentation](crons.md)
+

doc/development.rst → doc/development.md

@@ -1,43 +1,36 @@
-Development
-===========
+# Development
 
 
-Adding new file upload
-----------------------
+## Adding new file upload
 
 - Check mime type of file before upload
 - Add the new upload folder to .gitignore and add inside the new upload folder an empty file .gitkeep
 - If the new folder is outside of "web/uploads" folder add it to app/config/rsync_exclude.txt
 
-Adding new DB field
--------------------
+##  Adding new DB field
 
 - If the field is used in listing search criterias, add a DB index on it.
 
-Display user contents in pages
-------------------------------
+## Display user contents in pages
 
 - All user text fields (listing description, user description, messages between users, ...) must be filtered in twig 
 templates through the twig filter `strip_private_info`.
 
         Ex: listing_translation.description|strip_private_info
 
-Versioning
-----------
+## Versioning
 
 - Don't push modifications breaking major functionalities and complicating the app usage.
 
 
-Dynamic texts
--------------
+## Dynamic texts
 
 - Some texts must be added through Twig global parameters and not be hardcoded in twig templates.
 
         Ex: The phone is setted through cocorico_phone twig global parameter
         
 
-Twig
-----
+## Twig
 
 - Close all block to not break editor indentation.
 

doc/index.md

@@ -0,0 +1,22 @@
+# Cocorico Documentation
+
+
+## Table of Contents
+
+- [PHPdoc](http://docs.cocorico.io/phpdoc/index.html)
+- [Crons](crons.md)
+- [Mails](mails.md)
+- [Translations](translations.md)
+- [MongoDB](mongodb.md)
+- [Routing](routing.md)
+- [Parameters](parameters.md)
+- [Prices](prices.md)
+- [Times](times.md)
+- [Twig](twig.md)
+- [Breadcrumbs](breadcrumbs.md)
+- [Virtual Host](virtual-hosts.md)
+- [Tests](tests.md)
+- [Deployment](deployment.md)
+- [Troubleshooting](troubleshooting.md)
+- [WkHtml2PDF](wkhtml2pdf.md)
+