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 
    !
    !
    
    en
    !
    

• 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

• Page Home

• Page News
  • que fait-on de la rubrique news ?
  • Il faut mettre a jour acces to archive mailing list platforme

• Page Training
  • Mettre les nouveaux dates

• Page Index : homogeniser avec le bar en haut. Enlever pdf/html.
  • LF : Renommer en "Doc" ? (je suppose que c'est l'idée de l'homogénéisation des noms)
  • LF : Dans section 2, mettre directement les liens vers les pages des différents CC (pour l'instant, renvoie vers DocBenv#IDRIS par exemple, puis il faut recliquer pour accéder à la page sur l'IDRIS). Idem pour les liens de la section 9.

• Page Introduction
  • Phrase bizarre : Foreword : For common hardware platforms (also called "machines")
  • mettre à jour les configurations de references dans introduction
  • Enlever esci, corriger l'adresse platforme-users

• Page Environnment
  • On pourrait ajouter un petit intro de chaque des centre pour qu'il y a un peu plus qu'un lien dans chaque rubrique.
  • Mise à jour des pages où il y a encore la mention de Curie :
    • ​https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/DocBenvBtgcc#HowtoinstallyourenvironmentonTGCC
  • Passer en revue les conseils donnés pour chaque machine - supprimer les machines obsolètes

• Page Download
  • Proposition : changer le nom en "modipsl and how to install a configuration"
  • Sous rubrique Description pourrait etre changé en "Description of modipsl" et etouffer un peu de ce que c'est modipsl.
  • How to use modipsl : "After downloading and unpacking modipsl" unpacking ???
  • ins_job n'existe plus.
  • JG : Special cases : remove ORCHIDEE
  • installation : A relire mais doit être toujours à jour - eventuellement mettre à jour les exemples

• Page Compile
  • A mettre a jour
  • Ajouter l'explication des scripts de compilation dans IPSLCM6.2, LMDZOR_v6.2 et ICOLMDZOR_v7. - Attention des nouveaux paramètres dans config.card en découle et donc mettre à jour aussi la page setup

• Page Setup
  • A mettre a jour
  • réécrire la description des fichiers de sorties actuellement peu claire ​https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/DocFsimu#Endofthesimulation . Attention au Writefrequency versus utilisant des comp.card
  • description CalendarType?
  • mise en place simulation : semble toujours à jour, ajouter les nouveaux paramètres
  • 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à)
  • description des entêtes de jobs par machine

• Page Simulation and post-processing
  • JG Exemple de mail pas necessaire
  • documentation sur les packs
  • lien avec dr2xml et cie ?

• Page Monitor, debug and relaunch
  • JG proposition d'enlever Monitor du titre car le Monitoring est decrit dans le chaptire avant. On pourrait changer en "Check, debug and relauch simulation and post-processing jobs"
  • How to verify the status of your simulation : Mettre a jour le graph ou l'enlever. Il vient d'où ce graphe ? Qui a l'origine ?

• Page Configurations
  • A mettre a jour
  • Créer une page tableau indiquant pour chaque configuration disponible dans mod.def : ses résolutions / son état (mort lente / prod / en cours de dev) / un commentaire décrivant son utilisation (exercice cmip / nouvelles sources etc.)

• Page The IPSL models
  • Ajouter DYNAMICO
  • décrire 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

• Page Tools
  • Qq lignes de plus sur les outils qui ont juste un lien vers un site exterieur serait bien.

• Page FAQ
  • Peut-etre ici le seul endroit où garder le Table of contents en haut du page.
  • A relire

• Page About
  • History JG : a ecrire correctement ou enlever.

Autres idées

Peut être ajouter une rubrique "gestion des sorties" avec

• explication des architectures de rangement en focntion de prod/dev/test
• explication des architectures de rangement en fonction de la machine
• explication des packs
• explication des fréqunces de sorties par modèles - comment les modifier
• explication de l'utilisation de xios dans les modèles

Proposition rubriques pages configurations

• Description de la configuratin
• Technical details
  • How to use it
  • Computing performances
  • Restart files
  • Output level - gestion des outputs via XIOS
  • paramètres gérables et conseillés depuis les card
  • Lengths, frequencies conseillées
  • Computing centres
  • autres rubriques propres à chaque config.

Proposition organisation

​https://lite.framacalc.org/retraite-doc-plateforme-golf