doc: update documentation

suppression-manon-adrien
Sébastien Arod 2024-09-26 13:15:58 +02:00
parent ce3c5965c7
commit 44927f5c7c
1 changed files with 5 additions and 7 deletions

View File

@ -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>)` 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 `<id>.jpg` dimension 2048x2048