Configurer FRAGO

Comprendre comment configurer FRAGO pour la génération de rapports de synthèse pour le suivi et l’amélioration de l’accessibilité web.

Présentation

Le thème Frago a pour objectif d’aider à la génération de synthèses pour l’amélioration des démarches en ligne du gouvernement français..

Attention, goHugo est très sensible à l’architecture des contenus. Si les contenus sont absents ou présentent des erreurs le site peut planter. Si l’architecture du thème change, de même, il n’est plus possible d’utiliser les dernières versions du thème (sans modifier l’architecture de contenu).

Un maximum d’indications ont été ajoutés au code pour s’afficher dans la console (visible dans un terminal), si un cas mérite d’être signalé aller sur la page https://github.com/DISIC/frago/issues .

Démarrage (Configuration simplifiée)

Architecture de contenu

Exemple d’architecture d’un projet avec goHugo, voir : L’exemple d’architecture

.
├── config.toml
└── content
    └── audits
         ├── projet1
         │     ├── index.md // Ajouter un entête avec le titre de la démarche
         │     └── accessibility
         │          ├── 2020-10-15.csv
         │          ├── 2020-11-15.csv
         │          └── context.yml // Déclarer le contexte de chaque audit
         └── projet2
                ├── index.md // Ajouter un entête avec le titre de la démarche
                └── accessibility
                    ├── 2020-10-15.csv
                    ├── 2020-10-15.csv
                    └── context.yml // Déclarer le contexte de chaque audit

Récupérer un exemple de structure de contenu : https://github.com/DISIC/frago/tree/content /

Installer le thème

Télécharger le thème (pour un premier essai)

Télécharger le thème sur votre dépôt dans themes: themes/frago.

Lien de la dernière version du thème au format .zip : https://github.com/DISIC/frago/archive/refs/heads/master.zip .

Note : Si vous le téléchargez, il ne sera pas synchronisé avec le dépôt GitHub, il faudra le mettre à jour à la main. Pour le mettre à jour, supprimer, puis recréer le thème déjà initialement présent.

Appeler le dépôt du thème Hugo

Option pour la synchronisation et mise à jour « automatiques ».

Créer un répertoire themes

mkdir themes // unix

Accéder au répertoire themes

cd themes

Cloner le thème

git clone https://github.com/DISIC/frago.git/

Le thème est présent dans le répertoire themes/frago. Vous pouvez le synchroniser avec github comme n’importe quel dépôt .git.

Configuration

Ajouter le fichier : config.toml

baseURL = "/"
title = "Mon administration" # Ce qui s'affiche sur le site.
theme = "frago"

# Utilisés dans les documents légaux
[params]
  organisation = "Le nom complet de mon administration"
  [params.contacts]
    email = "referent-accessibilite@douane.finances.gouv.fr"
    address = "11, rue des deux Communes, 93558 Montreuil, cedex FRANCE"

Installation et configuration (avec les Modules goHugo)

Appeler le thème Hugo pour synchronisation et mise à jour automatiques (avec le système de module Go)

⚠️ Le langage Go doit être installé sur le système. Installé sur MacOS/Unix ou Linux, mais difficile à installer sur Windows sans les droits administrateurs.

title = "Mon administration"

[module]
  [[module.imports]]
    path = "github.com/disic/frago"

# Utilisés dans les documents légaux
[params]
  organisation = "Le nom complet de mon administration"
  [params.contacts]
    email = "referent-accessibilite@douane.finances.gouv.fr"
    address = "11, rue des deux Communes, 93558 Montreuil, cedex FRANCE"

Créer le fichier go.mod (commande dans le terminal)

hugo mod init github.com/organisme/nomdepotgit

Créer le fichier go.sum (commande dans le terminal)

hugo mod get github.com/disic/frago

Mettre à jour le thème le fichier go.sum (commande dans le terminal)

hugo mod get -u

Génération du site (mise en ligne)

Ligne de commande pour lancer le serveur en local sur votre machine

Serveur local : mode auditeur

hugo serve

Serveur local : mode synthèse (pour tester en local l’environnement de production)

HUGO_ENV="production" hugo serve --buildFuture --gc --minify

Site généré : mode synthèse

HUGO_ENV="production" hugo --buildFuture --gc --minify --cleanDestinationDir

Site généré : mode portail (à venir) HUGO_ENV=“portal” hugo –gc –minify –cleanDestinationDir

• HUGO_ENV="production" lance l’environnement de production (sans les outils d’aide à l’audit, peut être lancé avec le mode serve).
• --buildFuture Publier des éléments avec une date future. Ex: phase (optionnel) ou plan d’actions.
• --gc met à jour le cache de goHugo.
• --cleanDestinationDir nettoie le répertoire de génération du code (au cas où du code d’une précédente génération serait encore présent).
• --minify permet ¨de compresser le code HTML en ligne.