3.31 Procédures-site documentaire

3.31.1 - Installer tous les éléments

Pour manipuler modifier le site documentaire, il est faut :

  • cloner le dépôt des sources du projet
  • installer le HOOK git pre-commit en
    • copiant le fichier aInstaller_pre-commit présent à la racine du dépôt
    • le renommant pre-commit
    • le plaçant dans le répertoire .git/hooks

Le reste de la procédure d’installation de poste est disponible au chapitre §3.2.

3.31.2 - Démarrer / arrêter le site

Pour manipuler Hugo :

  • démarrer le site en dev : double-cliquer sur startServer.cmd
  • arrêter le site en dev : sélectionner la fenêtre de commande DOS et enfoncer les touches CTRL et C

3.31.3 - Modifier les pages

Pour enrichir les pages, modifier les pages présentes dans l’arborescence /content.

Les documentations de GoHugo est ici mais je vous conseille celle du thème utilisé (plus synthétique) ici.

3.31.4 - Modifier l’arborescence

L’ordre des pages est basé sur l’attribut weight présent dans les métadatas de chaque page (en haut entre les +++).

Dans ce projet, la documentation est prévue pour s’organiser sur 3 niveaux de profondeur maximum.

Donc le poids est la concaténation du numéro du chapitre avec chaque chapitre sur 2 chiffres. On obtient :

  • chapitre 1.2.3 => weight = 10203
  • chapitre 2.3.12 => wigth = 020312

3.31.5 - Générer la documentation technique

Une grande quantité d’information de la documentation est issue de documentation générée (notamment de la Javadoc).

Pour générer cette documentation, il faut exécuter la commande mvn clean install -P qualimetrie

__

3.31.6 - Créer le site documentaire statique

Pour cela, il faut :

  • ouvrir une ligne de commande dans le répertoire 1-conception
  • exécuter le script build.cmd qui
    • exécute la génération du site
    • vérifie tous le contenu du site et notamment les liens (avec htmltest
  • vérifier qu’aucun avertissement ou erreur ne remonte dans les logs affichés dans la console

__

3.31.7 - Mettre à jour la version d’Hugo

Pour mettre à jour la version d’Hugo :

  • depuis le site officiel de Hugo, télécharger la dernière version disponible avec le packaging windows-amd64.zip
  • extraire le fichier hugo.exe dans le répertoire 1-conception
  • démarrer Hugo (cf. chapitre précédent Démarrer / arrêter le site)
  • passer rapidement en revue les pages pour vérifier que tout fonctionne bien
  • vérifier qu’aucun avertissement ou erreur ne remonte dans les logs affichés dans la console
  • arrêter Hugo
  • builder Hugo (cf. chapitre Créer le site documentaire statique)
  • vérifier qu’aucun avertissement ou erreur ne remonte dans les logs affichés dans la console (autre que les erreurs de connexion à localhost ou dev-psl.guillaumetalbot.com)
  • mettre à jour la page de suivi pour indiquer la version installée de Hugo et la date de la prochaine mise à jour (dans 3 mois)