From 44927f5c7c490e7fccf6cabbf6ff1aa22f389b74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Arod?= Date: Thu, 26 Sep 2024 13:15:58 +0200 Subject: [PATCH] doc: update documentation --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f6ea866..af8a84c 100644 --- a/README.md +++ b/README.md @@ -18,15 +18,13 @@ Notion contient une [Liste des Familles à publier sur le site](https://www.noti ## Modifier le code pour ajouter une famille - Ajouter la famille dans la liste des résistants dans le fichier [src/resistants.ts](src/resistants.ts) en prenant les informations depuis Notion - - `id`: basé sur les noms des parents sans accents au format `prenom1-prenom2` ou `prenom-nom` pour les familles monoparentales. - - `noms`: les noms complets des parents au format `Prénom1 Nom1 et Prénom2 Nom2` - - `enfants`: Prénoms des enfants + - `id`: basé sur les noms des parents sans accents au format `prenom1-prenom2` ou `prenom-nom` pour les familles monoparentales sans accents ni caractères spéciaux. + - `noms`: les noms complets des parents au format `Prénom1 Nom1 et Prénom2 Nom2` ou `Prénom1 et Prénom2 NomCommun` + - `enfants`: Prénoms des enfants au format `Enfant 1, Enfant 2 et Enfant 3` - `departement`: Département parmi la liste de valeur défini dans le `type Departement` dans le fichier [src/Resistant.ts](src/Resistant.ts). Si le département manque dans la liste il faut le rajouter. - - `academie`: Académie parmie la liste de valeur défini dans le `type Academie` dans le fichier [src/Resistant.ts](src/Resistant.ts). Si l'académie manque dans la liste il faut la rajouter. - - `presentation`: Le text de presentation pour le site web. A prendre depuis le contenu de la page notion. ⚠️ Il est souvent nécessaire de nettoyer les fins de lignes et saut de ligne. (https://jsstringconverter.bbody.io/ peut-être utilisé pour convertir le textet en string js) - - `latitude` & `longitude`: à déterminer avec google maps à partir de la ville de la famille. + - `presentation`: Le text de presentation pour le site web. A prendre depuis le contenu de la page notion. ⚠️ Il est souvent nécessaire de nettoyer les fins de lignes et saut de ligne sur le contenu Notion. (https://jsstringconverter.bbody.io/ peut-être utilisé pour convertir le textet en string js, il faut cocher `Add Newlines` et mettre `Variable Name` à vide) + - `latitude` & `longitude`: à déterminer avec google maps à partir de la ville de la famille et prendre dans l'url les 2 elements qui suivent le @ par exemple pour [Lyon](https://www.google.fr/maps/place/Lyon/@45.7579507,4.8351301,18724m/data=!3m2!1e3!4b1!4m6!3m5!1s0x47f4ea516ae88797:0x408ab2ae4bb21f0!8m2!3d45.764043!4d4.835659!16zL20vMGRwcmc?hl=fr&entry=ttu&g_ep=EgoyMDI0MDkyMy4wIKXMDSoASAFQAw%3D%3D) les latitude et longitude sont 45.7580409 et 4.752729 - `date_declaration`: à prendre dans la preuve d'envoi du courrier de DC ou à defaut dans le corps du courrier ou à défaut la date d'intégration dans notion - - `lien_declaration`: `getResistantDeclarationUrl()` id définit au dessus, - `mention`: mention additionnelle. Laissé vide la plupart du temps. - `video`: vidéo de présentation. Laissé vide la plupart du temps. - Ajouter la photo: Ajouter la photo dans le répertoire [src/photos](src/photos) avec le nom `.jpg` dimension 2048x2048