NewDoc

Il s'agit du projet de refonte de la documentation. Cet objectif de refonte a plusieurs objectifs.

D''une part il s'agit de quitter le format DITA au profit d'un format plus light et plus simple à prendre en main et à maintenir.
D'autre part il s'agit de rendre la documentation moins verbeuse et plus juste. Le tout avec un affichage plus user friendly.

Nous avons fait pas mal de recherches et de tests depuis quelques semaines. Nous avons donc choisi un nouveau format pour la documentation, il s'agit de Markdown .

Aprés un peu de travail et grâce à Pandoc , nous avons réalisé une conversion des fichiers Dita francais au format HTML puis une conversion au format Markdown.

Nous disposons donc d'une base. (TODO créer les branches qui vont bien sur la forge)

Voici le plan de route donc : A partir des fichiers Markdown existants refaire une nouvelle documentation allégée et actualisée.

Plan de travail

  • Batir un plan simplifié par rapport à l'ancien (il s'agit à mon avis uniquement de fusion de fichiers au final, le plan doit peu changer).

Exemple : le glossaire peut être fondu dans un seul fichier glossaire.

Exemple 2 :

administration dictionnary
administration dictionnary dropdown
administration dictionnary printer
administration dictionnary software

Peut être fondu dans un seul fichier MD Administration_des_dictionnaires.md

Exemple 3 : les sections communes (gestion des documents, des ports réseaux, des connexions directes par exemple) ne sont pas à remettre X fois mais à centraliser à un seul endroit (partie commune ou comme info complémentaire dune section existante, à voir)

  • Créer les répertoires et chaque fichier MD conformément au plan avec un titre explicite en français : Administration_des_entités.md
  • Cop/coller les contenus des anciens fichiers MD de la documentation d'origine dans les nouveaux fichiers MD
  • Admirer le résultat dans Daux

TODO - Mise à jour WIKI forge -

  • Archiver l'ancienne documentation WIKI
  • Rédiger :

yllen : ajout de la syntaxe Markdown retenue (en me basant sur ce qui a été fait lors de la migration depuis Dita

On ne parle plus de TOPIC mais de chapitre
Présenter le nouveau plan

  • Etat de la documentation

Tableau avec le nouveau plan et le suivi

Yllen : les titres du tableau ci-dessous sont en français, il faudra bien évidemment les définir en anglais pour la partie en

Titre de chapitre page Markdown fr en
Index 00_index.md en cours
Preface 01_preface.md X
_02_Premiers_pas_avec_GLPI 01_Premiers_pas_avec_GLPI.md X
__02_Deployer_GLPI 01_Deployer_GLPI.md X
___02_Prerequis 01_Prérequis_nécessaires.md X
02_Prérequis_serveur.md X
03_Prérequis_base_de_données.md X
03_Installer_l'application.md X
04_Assistant_d'installation.md X
__03_Utiliser_GLPI 01_Utiliser_GLPI.md X
02_Découvrir_l'interface_de_GLPI.md X
03_Gérer_son_mot_de_passe.md en cours
04_Gérer_ses_préférences.md en cours
05_Naviguer_dans_les_modules_de_GLPI.md en cours
06_Interface_standard_et_interface_simplifiée.md en cours
07_Visualiser_les_enregistrements.md X
08_Rechercher.md X
_03_Module_Parc 01_Module_Parc.md en cours
02_Ordinateurs.md X
03_Moniteurs.md X
__04_Logiciels 01_Logiciels.md X
02_Onglet_Licences.md X
05_Matériels_réseaux.md X
06_Périphériques.md X
07_Imprimantes.md X
08_Cartouches.md X
09_Consommables.md en cours
10_Téléphones.md X
11_Global.md X
_04_Module_Assistance 01_Module_Assistance.md X
02_Définir_les_acteurs.md X
03_Définir_la_matrice_de_calcul_de_la_priorité.md X
04_Configuration_avancée.md X
05_Les_matrices_de_cycle_de_vie.md X
__06_Tickets 01_Règles_de_gestion.md en cours
02_Matrice_ce_cycle_de_vie.md X
03_Gérer_les_tickets.md X
04_Ouvrir_un_ticket.md en cours
05_Pour_aller_plus_loin.md en cours
07_Créer_un_ticket.md X
08_Problèmes.md en cours
09_Changements.md en cours
10_Planning.md en cours
11_Statistiques.md X
12_Tickets_récurrents.md en cours
_05_Module_Gestion 01_Module_Gestion.md X
02_Budgets.md X
03_Fournisseurs.md en cours
04_Contacts.md en cours
05_Contrats.md en cours
06_Documents.md X
_06_Module_Outils 01_Module_Outils.md X
__02_Projets 01_Projets.md X
02_Onglet_Tâches_de_projet.md X
03_Notes.md X
04_Flux_RSS.md X
05_Base_de_connaissances.md X
06_Réservations.md X
07_Rapports.md X
_07_Module_Administration 01_Module_Administration.md en cours
__02_Utilisateurs 01_Utilisateurs.md en cours
02_Importer_des_utilisateurs.md en cours
03_Groupes.md en cours
04_Entités.md en cours
__05_Règles 01_Gérer_les_règles.md X
02_Collecteur_de_courriels.md X
03_Habilitations_utilisateurs.md X
04_Règles_métier_pour_les_tickets.md X
05_Règles_outil_d'inventaire.md X
06_Dictionnaires.md X
__07_Profils 01_Profils.md en cours
02_Onglet_Assistance.md X
03_Onglet_Outils.md X
04_Onglet_Administration.md X
05_Onglet_Configuration.md X
08_File_d'attente_des_courriels.md en cours
09_Maintenance.md en cours
10_Journaux.md en cours
_08_Module_Configuration 01_Module_Configuration.md en cours
_02 Intitulés 01_Intitulés.md en cours
02_Onglet_Traduction.md X
03_Intitulés_Général.md X
04_Intitulés_Assistance.md X
05_Intitulés_Calendrier.md X
06_Intitulés_Internet.md X
03_Composants.md X
_04 Notifications 01_Configurer_les_notifications.md X
02_Configuration_des_suivis_par_courriels.md X
03_Modèles_de_notifications.md X
04_Notifications.md X
__05_Sla 01_Sla.md X
02_Niveaux_de_Sla.md X
__06_Générale 01_Configurer_les_paramètres_centraux.md X
02_Configuration_Générale.md X
03_Valeurs_par_défaut.md X
04_Parc.md X
05_Assistance.md X
06_Système.md X
07_Réplicats_MySQL.md X
07_Contrôles.md X
Les_différents_onglets Onglet_Changements.md X
Onglet_Composants.md X
Onglet_Connexions.md X
Onglet_Contrats.md X
Onglet_Coûts.md X
Onglet_Debug.md en cours
Onglet_Documents.md X
Onglet_Eléments.md X
Onglet_Fournisseurs.md X
Onglet_Gestion.md X
Onglet_Historique.md en cours
Onglet_Liens.md en cours
Onglet_Notes.md X
Onglet_Ports_réseaux.md en cours
Onglet_Problèmes.md X
Onglet_Réservations.md X
Onglet_Solution.md X
Onglet_Statistiques.md X
Onglet_Tâches.md X
Onglet_Tickets.md X
Onglet_Tous.md en cours
Onglet_Validations.md X
Les_différentes_actions Créer_un_nouvel_objet.md x
Gérer_les_gabarits.md x
Lier_contacts_et_fournisseurs.md x
Lier_un_contrat_à_un_objet.md x
Lier_un_document_à_un_objet.md x
Modifier_un_objet.md x
Supprimer_un_objet.md x
Transférer_un_objet.md x
Visualiser_un_objet.md x

images dans dossier /image au format png

Menus Parc - Gestion - Assistance terminés
Menu Outils - Administration en cours