Documentation d'AgroMetInfo
Description
Ce projet contient les sources pour les pages statiques du site AgroMetInfo, c'est-à-dire :
- la page d'accueil,
- la documentation pour les utilisateurs,
- les notes de version de tout le projet,
- les pages légales.
Les pages sont publiées à https://agroclim.pages.mia.inra.fr/agrometinfo/documentation/ après construction et tests des liens grâce à l'intégration continue GitLab-CI.
Installation
Les pages sont construites avec le générateur de site Hugo et le thème Hugo Relearn Theme.
- Récupérez les sources avec Git :
git clone git@forgemia.inra.fr:agroclim/agrometinfo/documentation.git
. - Installez une version de Hugo supérieure à 0.95.0.
- Rendez-vous dans le projet
cd documentation/
. - Lancez
hugo
pour la création des pages statiques ouhugo server --navigateToChanged
et naviguez sur http://localhost:1313/.
Modification de pages
Pour modifier ou ajouter une page :
-
Créez une branche depuis GitLab (exemple avec une branche
modification-accueil
) - Récupérez la branche sur votre poste :
git fetch git switch modification-accueil
- Visualisez le site :
- lancez
hugo server --navigateToChanged
, - ouvrez un navigateur sur http://localhost:1313/.
- lancez
- Modifiez le ou les fichiers, le navigateur affichera les pages correspondantes.
- Sous Linux, vérifiez les liens des pages :
bin/check.sh
. - Validez vos changements :
git commit -m "Modification de l'accueil"
. - Envoyez :
git push
. - Vérifiez la bonne exécution de l'intégration sur la page https://forgemia.inra.fr/agroclim/agrometinfo/documentation/-/pipelines.
- Faites une demande de fusion en choisissant « Écraser les commits lorsque la demande de fusion est acceptée. ».
- Faites relire.