finalize doc posts

content/cri/documentation.md

@@ -38,7 +38,7 @@ Les codes source
 
 > Toutes les contributions, corrections ou suggestions sont les bienvenues: une documentation à jour est un gain de temps pour tous au quotidien
 
-## Modifier [**doc-cri**](https://doc.cri.isima.fr/) ou [**doc-user**](https://doc.isima.fr/)
+## Comment contribuer à [**doc-cri**](https://doc.cri.isima.fr/) ou à [**doc-user**](https://doc.isima.fr/)
 
 ### Prérequis
 
@@ -49,13 +49,15 @@ Les codes source
 * savoir ce qu'est [markdown](https://guides.github.com/features/mastering-markdown/)
 * la commande [mkdocs](http://www.mkdocs.org/) installable via pip
 
-```bash
-sudo pip install
+```shell
+sudo pip install mkdocs
 ```  
 
 > N.B. il est aussi possible d'installer mkdocs dans un virtualenv python afin de préserver l'installation système
 
-### 2. récupérer les sources à partir de [https://gitlab.isima.fr](https://gitlab.isima.fr)
+#### Avec une copie locale du repo git (recommandée <i class="fa fa-thumbs-o-up" aria-hidden="true"></i>)
+
+##### 1 - Récupérer les sources à partir de [https://gitlab.isima.fr](https://gitlab.isima.fr)
 
 ```bash
 cd /path/to/your/projects/folder
@@ -63,45 +65,37 @@ git clone https://gitlab.isima.fr/cri/doc-cri
 cd doc-cri
 ```  
 
-### 3. démarrer l'environnement local
+##### 2 - Démarrer l'environnement mkdocs local
 
 ```bash
 mkdocs serve
 ```
 
-* ourvir [http://127.0.0.1:8000](http://127.0.0.1:8000) dans votre navigateur
-
-
-### 4. créer ou éditer du contenu
+[http://127.0.0.1:8000](http://127.0.0.1:8000) vous permet d'accéder au rendu de la doc en local
 
-#### 4.1 éditer du contenu
+##### 3 - Créer ou éditer du contenu
 
-* editer les fichiers [markdown (&ast;.md)](https://guides.github.com/features/mastering-markdown/) dans le dossier ```docs```
+###### 3.1 - Editer du contenu existant
 
-    * [atom.io](https://atom.io/) possède une coloration syntaxique et une prévisualisation pour [markdown](https://guides.github.com/features/mastering-markdown/) (ctrl+maj+m)
+* editer les fichiers [markdown (*.md)](https://guides.github.com/features/mastering-markdown/) dans le dossier ```docs```
+    * [atom.io](https://atom.io/) possède une coloration syntaxique et une prévisualisation pour [markdown](https://guides.github.com/features/mastering-markdown/) **(ctrl+maj+m)**
 
 * les changements sont automatiquement rendus après sauvegarde du fichier sur [http://127.0.0.1:8000](http://127.0.0.1:8000)
 
-#### 4.2 ajouter du contenu
+###### 3.2 - Ajouter du contenu
 
-1. créer un nouveau fichier markdown (.md) dans le dossier ```docs``` ou dans l'un de ses sous dossiers
+* créer un nouveau fichier markdown (.md) dans le dossier ```docs``` ou dans l'un de ses sous dossiers
 
-> un fichier template.md est diponible directement dasn le dossier doc
-
-> l'architecture des sous dossiers devrait suivre l'architecture du menu général mentionné ci-après
-
-
-2. dans ```mkdocs.yml```
-  1. ajouter une entrée à la section ```page:``` afin d'ajouter le nouveau fichier au menu
+* dans ```mkdocs.yml``` ajouter une entrée à la section ```page:``` afin d'ajouter le nouveau fichier au menu
     * le nouveau fichier peut être ajouté à un sous menu
 
-      ```yml
+```yaml
 pages:
     - 'Section':
         - 'Subsection': subsection.md
 ```
 
-### 6. Versionner et propager les modifications
+###### 3.3 - Versionner et propager les modifications
 
 * Ajouter tous le nouveaux fichiers au prochain commit
 
@@ -120,80 +114,20 @@ git commit -m "my awesome contribution"
 ```bash  
 git push origin master
 ```
-### La documentation est automatiquement mise à jour à la suite de cette opération !! :clap_tone1:
-
-
-```bash
-mkdocs
-atom preview
-git add . --all
-git commit -m "message explicite"
-git commit --amend
-git push origin master
-git status
-git pull --rebase
-git statsh
-git apply
-```
-
-### Faire une demande de documentation
-
-###### Avec un virtualenv (c'est à dire en utilisant une installation isolée de l'OS )
-
-Vérifiez si vous avez virtualenv déjà installé:
-
-$ python -m venv
-usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
-            [--upgrade] [--without-pip]
-            ENV_DIR [ENV_DIR ...]
-venv: error: the following arguments are required: ENV_DIR
-
-Si cette commande ne marche pas, il faudra installer virtualenv:
-
-pip install --user virtualenv
-
-Si vous avez besoin d’un rappel sur pip, c’est par là.
-
-Ensuite, pour chacun de vos projets, créez un environnement virtuel, avec:
-
-python -m venv /path/vers/projet/env_nom_du_projet
-
-Si vous l’aviez déjà. Ou:
-
-virtualenv /path/vers/projet/env_nom_du_projet
-
-Choisir une version de Python
-
-Parfois vous voudrez utiliser une version spécifique de Python. Vous pouvez tout à fait créer un env dédié à Python 3.2 et un autre à Python 2.6, il faut juste que les deux versions soient installées sur votre système.
-
-Je ne vais pas détailler commen installer deux versions de Python en parallèle sur chaque OS car je n’ai aucune idée de comment on fait sous Mac ou Windows, mais sous Ubuntu c’est très simple: par défaut on est en Python 2.7, et pour installer Python 3, on fait sudo apt-get install python3. Pour installer Python 2.6, on fait sudo apt-get python2.6.
-
-On a alors 3 executables: /usr/bin/python va déclencher Python 2.7, /usr/bin/python2.6 va appeler Python 2.6, etc. Aucun conflit système, c’est merveilleux.
-
-Il ne reste qu’à construire son environnement virtuel en lui passant en paramètre le chemin vers le Python à utiliser:
-
-virtualenv mon_env -p /usr/bin/python2.6
-
-Si vous êtes sous Windows, vous pouvez aller boire une bière à la cuisine, ça ne marche pas sous votre OS.
-
-Pour les chanceux qui ont accès à un Unix, il existe un merveilleux logiciel qui va vous éviter le yoyo entre les envs:
+<i class="fa fa-hand-peace-o" aria-hidden="true"></i> La documentation est automatiquement mise à jour à la suite de cette opération via l'intégration continue de gitlab !!
 
-pip install --user virtualenvwrapper
+#### En modifiant directement sur le [<i class="fa fa-gitlab" aria-hidden="true"></i> gitlab de l'ISIMA](https://gitlab.isima.fr)
 
-Ensuite il faut rajouter quelques lignes dans votre script d’init de shell, par exemple dans ~/.bashrc:
+Sur toutes les pages de  [**doc-cri**](https://doc.cri.isima.fr/) et [**doc-user**](https://doc.isima.fr/) vous retrouverez l'icône <i class="fa fa-pencil-square-o" aria-hidden="true"></i> qui vous permettra de modifier le contenu de la page en markdown directement dans [https://gitlab.isima.fr](https://gitlab.isima.fr).
 
-export WORKON_HOME=~/.virtualenvs
-mkdir -p $WORKON_HOME
-source ~/.local/bin/virtualenvwrapper.sh
+[![Edit via gitlab](images/cri/edit-gitlab-thumb.png)](images/cri/edit-gitlab.png)
 
-Selon où vous avez installé virtualenvwrapper, la dernière ligne peut changer. Moi, mon virtualenv est installé au niveau du système dont le chemin est plutôt /usr/local/bin/virtualenvwrapper.sh.
+> N.B. veillez à mettre un message explicite avant de cliquer sur le bouton "Commit Changes"
 
-Ces lignes vont lancer virtualenvwrapper en permanence dans le shell. Relancez le terminal pour l’activer. Le premier lancement va vous afficher un tas de lignes, rassurez-vous, ça n’arrive qu’une fois.
+> N.B. à chaque fois que vous cliquerez sur le bouton "Commit Changes" un nouveau commit sera créé dans l'historique des modifications du repository. Pour des changements allant au delà de l'ajout de quelques lignes vous devriez [contribuer avec une copie locale du repo git](http://localhost:8000/les-documentations-cri-et-utilisateur-pour-lisima.html#avec-une-copie-locale-du-repo-git-recommandee)
 
-Ensuite, vous avez accès à de nouvelles commandes:
+## Comment faire une demande d'ajout ou de modification
 
-    mkvirtualenv nom_env va créer un virtualenv dans le dossier ~/.virtualenvs, où que vous soyez.
-    workon nom_env va automatiquement activer un env, où que vous soyez.
-    rmvirtualenv nom_env va surpprimer l’env du même nom.
+Vous pouvez adresser toutes vos demandes ou remarques en cliquant sur le lien "Issues"
 
-Les options de mkvirtualenv sont les mêmes que pour la commande virtualenv, vous n’avez juste plus à vous souciez de où sont vos envs, ni de où vous êtes.
+[![Issues via gitlab](images/cri/issue-gitlab-thumb.png)](images/cri/issue-gitlab.png)

content/gitlab/gitlab.md

+Title: gitlab
+Date: 2017-05-16 10:20
+Status: Published
+Tags: www, dev

content/tech/git.md

+https://try.github.io/levels/1/challenges/25
+
+http://gitreal.codeschool.com/?utm_source=github&utm_medium=codeschool_option&utm_campaign=trygit
+
+http://themouette.github.io/slides-git/?theme=clermontech#/
+
+https://speakerdeck.com/willdurand/git-and-github-and-open-source-clermontech-workshop-git

content/tech/markdown.md

+Title: markdown
+Date: 2017-05-16 10:20
+Status: Published
+Tags: www, dev
+
 https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet