Enhance doc

README.md

@@ -9,6 +9,8 @@
 
 Incipio est un projet qui vise à bâtir un [ERP](http://fr.wikipedia.org/wiki/Progiciel_de_gestion_int%C3%A9gr%C3%A9) communautaire et libre pour l’ensemble des structures de type Junior-Entreprise, faisant partie ou non de la [CNJE](http://www.junior-entreprises.com/).
 
+**Note :** Cette version est actuellement en développement. Pour voir la dernière version stable d'Incipio, cliquez [ici](https://github.com/in6pio/Incipio/tree/1.X).
+
 ## Documentation
 
 [Documentation](https://github.com/in6pio/Incipio/wiki)

Vagrantfile

@@ -24,6 +24,7 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   # within the machine from a port on the host machine. In the example below,
   # accessing "localhost:8080" will access port 80 on the guest machine.
   config.vm.network "forwarded_port", guest: 80, host: 8080    # Web server
+  config.vm.network "forwarded_port", guest: 9000, host: 9000  # Mkdocs web server
   config.vm.network "forwarded_port", guest: 3306, host: 3307  # MySQL server
   config.vm.network "forwarded_port", guest: 6379, host: 6379  # redis server
 

ansible/roles/init/tasks/main.yml

@@ -15,6 +15,7 @@
     - build-essential
     - curl
     - python-software-properties
+    - python-pip
     - telnet
     - unzip
     - wget

ansible/roles/shell/tasks/main.yml

@@ -2,6 +2,9 @@
 - name:     Configure vagrant user shell prompt
   template: src=bashrc.j2 dest=/home/vagrant/.bashrc
 
+- name: Install Mkdocs
+  shell: sudo pip install mkdocs
+
 - name: Install Vim
   sudo: yes
   apt:  pkg=vim state=present

ansible/roles/shell/templates/bashrc.j2

@@ -142,7 +142,7 @@ extract () {
 # edit aliases configuration
 alias config='${EDITOR} ~/.bashrc'
 alias reload='source ~/.bashrc'
-alias update='sudo apt-get update && sudo apt-get upgrade && sudo apt-get autoremove && sudo composer self-update'
+alias update='sudo apt-get update && sudo apt-get upgrade && sudo apt-get autoremove && sudo composer self-update && composer global update && sudo pip install --upgrade pip'
 
 # Symfony2
 APP_DIR='/var/www/{{ symfony_src_dir }}/app'

docs/dev-guide/continuous-integration.md

@@ -0,0 +1 @@
+# Continuous Integration

docs/dev-guide/dev-environment.md

@@ -12,7 +12,7 @@ The purpose of this environment is to ease the development process. We preconfig
 ## Install
 
 * Install the requirements
-* Install the Vagrant box: `vagrant box add jessie http://static.gender-api.com/debian-8-jessie-rc2-x64-slim.box --provider virtualbox`
+* Clone the project and go inside the project folder with your console
 * Start the Vagrant VM: `vagrant up`
 
 If the provision fails, you can try to run ad hoc Ansible commands with a greater verbosity:
@@ -78,4 +78,4 @@ Shell aliases: run `alias` to see the available aliases.
 
 # Known bugs
 
-It is possible that the update of the system and the composer install takes very long. For the later, you can drop the task and run it manually it usually takes less time and at least you have an idea of the progress. If you do so, you will have to run manually the tasks which have been configured after this command. Hopefully, it is just creating the database or updating it ;)
+It is possible that the update of the system and the composer install takes very long. For the later, you can drop the task and run it manually it usually takes less time and at least you have an idea of the progress. If you do so, you will have to run manually the tasks which have been configured after this command. Hopefully, it is just creating the database or updating it ;)

docs/dev-guide/git-workflow.md

@@ -1,6 +1,6 @@
-# Git Workflow: triangular workflow
+# Git Workflow
 
-You do not have the rights to directly write on the project. Hence if you wish to push some code, the best thing to do is to **fork** the project. Once done, you will have a copy of the the repository [in6pio/Incipio](https://github.com/in6pio/Incipio) to your own namespace, with write access.
+The Git process being used is commonly called triangular workflow. You do not have the rights to directly write on the project. Hence if you wish to push some code, the best thing to do is to **fork** the project. Once done, you will have a copy of the the repository [in6pio/Incipio](https://github.com/in6pio/Incipio) to your own namespace, with write access.
 
 On your fork, you can develop and do changes as you wish. We recommend you to do your modifications in separate branches so that you can keep the original branches up to date with the original repository.
 
@@ -118,4 +118,4 @@ Good coding!
 * [Git branch strategy for small dev team](http://stackoverflow.com/questions/2428722/git-branch-strategy-for-small-dev-team) - Bilal and Olga | March 11, 2010
 * [Git Branching - Branching Workflows](http://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows) - Git official doc
 * [Comparing Workflows](https://www.atlassian.com/git/tutorials/comparing-workflows/) - *Atlassian*
-* [Git Workflow in Invenio](http://invenio-software.org/wiki/Tools/Git/Workflow) - *Invenio*
+* [Git Workflow in Invenio](http://invenio-software.org/wiki/Tools/Git/Workflow) - *Invenio*

docs/dev-guide/project-documentation.md

@@ -0,0 +1,9 @@
+# Project documentation
+
+Incipio documentation is generated with [Mkdocs][1]. To contribute to the documentation, you will find everything inside the `docs` folder and the configuration in `mkdocs.yml`.
+
+[Mkdocs][1] is builded using Python. As such to run it locally you will have to check [Mkdocs installation process](http://www.mkdocs.org/#installation). It is pre-installed with the Vagrant VM, to use it, check the `mkdocs` command.
+
+To start to see the doc, run `mkdocs serve` in the project folder.
+
+[1]: http://www.mkdocs.org

docs/index.md

@@ -6,6 +6,10 @@ Incipio est un projet qui vise à bâtir un [ERP](http://fr.wikipedia.org/wiki/P
 
 Si vous souhaitez contribuer ou faire remonter un bug, n'hésitez pas à [nous écrire un ticket ou une demande](https://github.com/in6pio/Incipio/issues).
 
+## Roadmap
+
+* [Milestones](https://github.com/in6pio/Incipio/milestones)
+* [Waffle Board](https://waffle.io/in6pio/Incipio)
 
 ## Guide Utiliateur
 * [Installation](user-guide/install.md)
@@ -15,9 +19,28 @@ Si vous souhaitez contribuer ou faire remonter un bug, n'hésitez pas à [nous 
 
 ## Guide Développeur
 
+* [Getting started](dev-guide/dev-environment.md)
 * [Git workflow](dev-guide/git-workflow.md)
-* [VM for dev](dev-guide/dev-environment.md)
 * [Configure your environment](dev-guide/dev-tools.md)
 * [Coding guidelines](dev-guide/coding-guidelines.md)
 * [API Documentation](dev-guide/api.md)
-* [Document your work](dev-guide/documentation.md)
+* [Document your work](dev-guide/documentation.md)
+
+
+## Rapports
+
+* [Scrutinizer](https://scrutinizer-ci.com/g/in6pio/Incipio/?branch=master)
+* [Codacy](https://www.codacy.com/app/theofidry/Incipio/dashboard)
+* [SensioLabs Insight](https://insight.sensiolabs.com/projects/4720058c-4915-465c-8039-0bfd5fe5bf63)
+* [Travis](https://travis-ci.org/in6pio/Incipio?branch=master)
+
+* [Coverage PHPunit](http://in6pio.github.io/Incipio/reports/phpunit/dashboard)
+* [App PhpMetrics](http://in6pio.github.io/Incipio/reports/phpmetrics/app)
+* [ApiBundle PhpMetrics](http://in6pio.github.io/Incipio/reports/phpmetrics/api-bundle)
+* [FrontBundle PhpMetrics](http://in6pio.github.io/Incipio/reports/phpmetrics/front-bundle)
+* [Application API (code)](http://in6pio.github.io/Incipio/api-doc)
+
+
+## J.E. utilisant Incipio (publiquement)
+
+* [Emagine-JE](https://github.com/Emagine-JE/Incipio)

mkdocs.yml

@@ -5,6 +5,7 @@ repo_name: GitHub
 copyright: Copyright &#169 2015 in6pio.
 docs_dir: docs
 site_dir: gh-pages
+dev_addr: 0.0.0.0:9000
 
 theme: flatly
 
@@ -15,10 +16,11 @@ pages:
         - Premières Utiliations:      user-guide/first-use.md
         - Module gestion Associative: user-guide/user-management.md
     - Guide développeur:
+        - Getting started:            dev-guide/dev-environment.md
         - Git workflow:               dev-guide/git-workflow.md
-        - VM for dev:                 dev-guide/dev-environment.md
+        - Continuous integration:     dev-guide/continuous-integration.md
         - Configure your environment: dev-guide/dev-tools.md
         - Coding guidelines:          dev-guide/coding-guidelines.md
         - API Documentation:          dev-guide/api.md
-        - Document your work:         dev-guide/documentation.md
+        - Project documentation:      dev-guide/project-documentation.md
     - About: about.md