From f1d203fcbfe173125e6d51282c7798cd16facbf4 Mon Sep 17 00:00:00 2001 From: Sebastien Arod Date: Tue, 11 Jun 2024 09:58:08 +0200 Subject: [PATCH] doc: clarify doc on integration --- README.md | 45 +++++++++++++++++++++++++++++++++------------ 1 file changed, 33 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 26dfe50..dc5980e 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,11 @@ La liste des résistants enfance libre est gérée par le code dans ce repo git. Ce code gère la liste des résistants en vue carte, vue liste, vue photo et en vue détaillée. -La liste est embarquée dans le site global squarespace par iframe à deux endroits: +La liste est embarquée dans le site global squarespace à deux endroits: - Sur la home page (https://www.enfance-libre.fr/) - Sur la page résistants (https://www.enfance-libre.fr/resistants). -Avec 2 différences : - -- La taille d’iframe -- Le mode par défaut du composant liste: qui est en mode carte sur la home page et liste sur la page résistants - # Ajouter une famille ## Quelles familles ajouter @@ -46,13 +41,39 @@ yarn dev peut être utilisé pour vérifier que le contenu pour la famille. - http://localhost:5173/resistants/#/ permet de vérifier que la liste s’affiche bien - http://localhost:5173/resistants/#/id permet de vérifier que le détail d’une famille s’affiche bien -⚠️Attention cependant: - -- les page s’affiche légèrement différemment (le css du site manque probablement) - -La vérification complète ne peut donc se faire qu’après publication. - ## Publier les changements - Commiter avec un commit message “feat: ajout de Prénom1 et Prénom2” - Le push vers main va déclencher la CI de mise à jour du site web. + +# Archi + +## Code + +Le code utilisé dans squarespace pour le chargement du modules est le suivant: + +```html +
+ + +``` + +Il faut faire attention à ce que que les points d'entrés exposé par la build soient toujours syncrhonisé avec le code dans squarespace. + +## Gestion des urls du site squarespace vs frama.io + +Le js et les assets du module résistants sont servis depuis la gitlab page de framagit (https://enfance-libre.frama.io/resistants) alors que le site est géré par squarespace sous le domaine https://www.enfance-libre.fr/. +Les assets doivent donc être gérés en url absolue, pour ceci on utilise notemment le paramètre "base" dans la config bite différement en dev et en build de ci. + +## Différences entre la home page et page résistants + +- La taille du composant +- Le mode par défaut: en mode carte sur la home page et liste sur la page résistants +- La gestion de la navigation: La navigation sur le détail dans la home page redirigre vers le détails dans la page résistants