Première ébauche de documentation de Transparency

Reste du travail <3

docs/docs/about/licence.md

@@ -0,0 +1,6 @@
+# Licence
+
+Cette documentation est placée, sauf mention spécifique sur une page ou un media, sous double licence :
+
+- [Art Libre 1.3 ou supérieur](http://artlibre.org/licence/lal/ "page de la licence lal")
+- [Créative Commons CC-by-sa 3.0 ou supérieur](https://creativecommons.org/licenses/by-sa/3.0/fr/legalcode "page de la licence CC-by-sa FR 3.0")

docs/docs/about/mentions-legales.md

@@ -0,0 +1 @@
+# Mentions légales

docs/docs/admin-guide/biens.md

@@ -0,0 +1,3 @@
+# Gestion des matériels et frais d'accès
+
+

docs/docs/admin-guide/couts.md

@@ -0,0 +1,3 @@
+# Gestion des coûts mensuels
+
+

docs/docs/admin-guide/documents.md

@@ -0,0 +1,3 @@
+# Gestion des documents
+
+

docs/docs/admin-guide/index.md

@@ -0,0 +1,10 @@
+# Interface d'administration
+
+L'interface d'administration de Transparency est disponible dans le dossier du domaine où vous l'avez /admin installée : ''http://domaine.tld/admin''
+
+Elle contient deux espaces principaux :
+
+- [la gestion des utilisateurs](utilisateurs.md)
+- [la gestion des documents](documents.md)
+
+

docs/docs/admin-guide/services.md

@@ -0,0 +1,3 @@
+# Gestion des services
+
+

docs/docs/admin-guide/utilisateurs.md

@@ -0,0 +1,56 @@
+# Gestion des utilisateurs
+
+## Ajout d'un utilisateur
+
+Accès :
+
+- directement depuis la page d'accueil de l'[interface d'administration](index.md), cliquez sur le bouton **Ajouter** (icone *plus*) de la partie **Utilisateur**.
+- dans la page **Utilisateurs**, cliquez sur le bouton **Ajouter utilisateur** en haut à droite.
+
+Les seuls champs à compléter sont :
+
+- Nom d'utilisateur : l'identifiant ;
+- Mot de passe ;
+- Confirmation du mot de passe.
+Cliquez alors sur le bouton :
+
+- **Enregistrer**, équivalent à **Enregistrer et continuer les modifications**, pour enregistrer et aller sur la page d'édition de l'utilisateur (voire partie suivante) ;
+- **Enregistrer et ajouter un nouveau** pour enregistrer et continuer à créer des utilisateurs.
+
+Il faut ensuite 
+
+
+## Édition d'un utilisateur
+
+Accès :
+
+- directement depuis la page d'accueil de l'[interface d'administration](index.md), cliquez sur le bouton **Modifier** (icone *crayon*) de la partie **Utilisateur**.
+- dans la page **Utilisateurs**, cliquez sur l'identifant de l'utilisateur que vous souhaitez modifier ;
+- ou à la suite de la création d'un utilisateur.
+
+Champs :
+
+- *Informations du compte* :
+  - Nom d'utilisateur : l'identifiant ;
+  - Mot de passe ;
+- *Informations personnelles* :
+  - Prénom (facultatif) ;
+  - Nom (facultatif) ;
+  - Adresse électronique (facultatif) ;
+- *Permissions*, avec 3 cases à cocher :
+  - Actif : cochée par défaut, indique si l'utilisateur est actif ou non ;
+  - Statut équipe : décochée par défaut, permet la connexion à l'interface d'administrateur ;
+  - Statut super-administrateur : décochée par défaut, donne toutes les permissions nécessaires à la gestion des documents, etc.
+Ces 3 dernières cases doivent être cochées pour qu'un utilisateur puisse administrer Transparency.
+
+N'oubliez pas de cliquer sur le bouton **Enregistrer** en bas de la fiche de l'utilisateur afin que les modifications soient prises en compte ; les boutons **Enregistrer et ajouter un nouveau** ou **Enregistrer et continuer les modifications** sont aussi disponibles suivant les actions que vous souhaitez réaliser par la suite. .
+
+### Modification du mot de passe
+À noter que pour modifier le mot de passe d'un utilisateur, il faut aller sur le formulaire dédié dont le lien est disponible à la fin du champ montrant la clé de contrôle du mot de passe actuel de l'utisateur.
+
+Un utilisateur peut aussi modifier son propre mot de passe en suivant le lien **Modifier le mot de passe** dans la barre de menu du haut.
+
+## Suppression d'un utilisateur
+
+Vous devez aller dans la partie **Utilisateur** disponible depuis la page d'accueil de l'[interface d'administration](index.md) de Transparency.
+Sélectionner le(s) utilisateur(s) à supprimer puis dans le menu **Actions** choisir **Supprimer les utilisateurs sélectionnés**.

docs/docs/contribuer.md

@@ -0,0 +1,7 @@
+Au code
+=======
+Se référer aux instructions du fichier [README](https://code.ffdn.org/jocelyn/transparency/src/master/README.md).
+
+À la documentation
+==================
+TODO

docs/docs/index.md

@@ -1,17 +1,3 @@
-# Welcome to MkDocs
+# Documentation de Transparency
 
-For full documentation visit [mkdocs.org](http://mkdocs.org).
-
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs help` - Print this help message.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+*En cours de rédaction !*

docs/docs/test.md

@@ -1,2 +0,0 @@
-Coucou
-======

docs/docs/user-guide/index.md

@@ -0,0 +1,32 @@
+# Guide Utilisateur
+
+## Connexion
+
+Afin d'avoir accès aux différents documents, il est nécessaire de s'identifier sur Transparency ; il n'y a pas de partie publique par défaut.
+
+## Documents
+
+Un document peut-être de deux types :
+
+- **Rapport de transparence**, soit un relevé de coût effectué en début de chaque mois, qui peut être utilisé comme base au calcul des prix libres. 
+- **Estimation et étude**, soit un outil pour établir des budgets prévisionnels pour des services à venir.
+
+L'objectif de chaque **document** est de calculer les **coûts de revient** des différents services proposés par l'association, en prenant en compte les **coûts mensuels** et les **matériels et frais d'accès** nécessaires à leur mise en œuvre. 
+
+### Coûts mensuel
+
+Les coûts mensuels peuvent être répartis en parties :
+
+- **Le réccurent** : qui comprend ce que les fournisseurs de l'association lui facturent chaque mois ;
+- **L'amortissement** : qui permet à l'association d'anticiper le renouvellement du matériel lorsqu'il casse ou devient obsolète. 
+
+### Matériels et frais d'accès
+
+Les coûts mensuels sont majoritairement de deux types :
+
+- **Matériels** : les équipements que l'association a du acquérir pour mettre un place un service ;
+- **Frais d'accès** : les sommes qui ont été nécessaires pour souscrire un abonnement chez un fournisseur et à payer au début du contrat.
+
+### Services
+
+Les **services** que l'association propose à ses membres ont un **prix de revient** qui dépend de l'utilisation des différentes ressources disponibles payées dans les **coûts mensuels** et les **matériels et frais d'accès**.

docs/mkdocs.yml

@@ -1 +1,15 @@
-site_name: My Docs
+site_name: TransparencyDoc
+
+pages:
+- Accueil: 'index.md'
+- Guide utilisateur: 'user-guide/index.md'
+- Guide administrateur:
+    - 'Gestion des utilisateurs': 'admin-guide/utilisateurs.md'
+    - 'Gestion des documents': 'admin-guide/documents.md'
+    - 'Gestion des coûts': 'admin-guide/couts.md'
+    - 'Gestion des biens': 'admin-guide/biens.md'
+    - 'Gestion des services': 'admin-guide/utilisateurs.md'
+- Contribuer: 'contribuer.md'
+- À propos:
+    - 'Licence': 'about/licence.md'
+    - 'Mentions légales': 'about/mentions-legales.md'