Documentation : To do or not to do ? that is the question

To Do Liste et propositions 2019

Structure

• Table of Contents
  • JG : je propose d'enlever le "Table of content" au debut de la page car duplique le carré jaune sur la droite. Et d'ajouter un niveau de detail dans le Table of Content dans le carré jaune. Vous pouvez voir deux exemples : DocBenvTmp versus DocBenv et DocCinstallTmp? versus DocCinstall . Pour faire cela :

    changer en haut de chaque page 
    [[TOC(heading=Table of contents,depth=1,inline)]]
    [[PageOutline(1,Table of contents,pullout)]]
    
    en
    [[PageOutline(1-2,Table of contents)]]
    

• Conserve-t-on l'arborescence à plat des pages qui permettait l'édition en pdf, ou revient-on à une arborescence plus classique ? Ou change-t-on d'outil ?
  • JG : je ne pense pas nécessaire de faire un pdf. Je propose de rester sur le wiki et de changer vers un structure hiérarchique Doc/NomduChapitre/Souspage Voir exemple ici : Doc/Config/ORCHIDEE_OL . Dans cette exemple, on ne peut pas cliquer sur Config en haut a gauche pour revenir vers le chapitre Config car cette page n'est pas transformé, mais ca le serait si on bascule.

• Titre des chapitre
  • JG je propose d’améliorer la cohérence des noms des chapitres (install versus download par exemple) avec leur onglets dans le bar en haut. Peut-etre ajouter le numero du chapitre : 1. Intro, 2. Environnement, etc... Et pour gagner de la place, enlever l'onglet About et peut-etre News.

Contenu

• Explication de la gestion des sorties (TEST vers scratc ou work idris, PROD DEV vers store, work tgcc et idris et ergon, gestion des packs à partir de là)

• Mise à jour des pages où il y a encore la mention de Curie :
  • ​https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/DocBenvBtgcc#HowtoinstallyourenvironmentonTGCC

• description CalendarType?

• description des entêtes de jobs par machine

• réécrire la description des fichiers de sorties actuellement peu claire ​https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/DocFsimu#Endofthesimulation
• ecrire la nouvelle gestion des frequences dans les cas de l'ocean et de la vegetation
• lien avec xios ajouter une page peut ere pour les descriptions des field et file xml
• lien avec dr2xml et cie ?

• documentation sur les packs

• que fait-on de la rubrique news ?

• mettre à jour les configurations de references dans introduction

• environnement : passer en revue les conseils donnés pour chaque machine - supprimer les machines obsolètes

• installation : A relire mais doit être toujours à jour - eventuellement mettre à jour les exemples

• COmpilation : préparer la documentation pour les nouveaux scripts - attention des nouveaux paramètres dans config.card en découle et donc mettre à jour aussi la page setup

• mise en place simulation : semble toujours à jour, ajouter les nouveaux paramètres,