Merge branch 'develop' into 'synchro-github-ans'

Develop

See merge request ASIP-Sante/g2/esante-ressources!24

Author: Klee-scoisne

README.md

@@ -1,13 +1,18 @@
-# S.K.E.L.E.T.O.R
+# ANS - RESSOURCES
+### Design System de l'ANS
+
+---
 
 Framework CSS créé par les équipes front d'Alterway.
+Maintenu par Klee Interactive.
 - BEM pour le nommage des class et id
 - SASS pour le CSS
 - jQuery ou Vanilla JS selon le besoin
 - Accessibilité : RGAA (AA) exigé
 - GULP 4.x.x
+- Docksal
 
-# Génération du projet
+## Génération du projet
 
 Pour la première fois
 ```
@@ -29,30 +34,32 @@ Pour lancer avec le watcher
 fin watch
 ```
 
-## Si le GULP plante
+### Si le GULP plante
 
 Faire :
-- rm -rf node_modules
-- rm -rf package-lock.json
-- fin npm cache clean --force
-- fin npm install
-
+```
+rm -rf node_modules
+rm -rf package-lock.json
+fin npm cache clean --force
+fin npm install
+```
+---
 # Les grands principes
 
-## Base
+### Base
 - Héritage de Boostrap 4.x.x
 - OOCSS et BEM
 - Architecture en Atomic Design
 - Compilation via Gulp 4.x.x
 
-## Javascript
+### Javascript
 Les plugins JS sont en jQuery pour la majorité d'entre eux.
 Ils respectent les patterns d'accessibilité.
 
-## Accessibilité
+### Accessibilité
 Respecter le RGAA, coder de façon accessible tant en HTML (twig), en CSS et en JS.
 
-## Composants
+### Composants
 - dossier TWIG des composants : `web/twig/site/component`.
 - dossier CSS des composants : `web/style/site/5-component`.
 
@@ -62,12 +69,21 @@ Ex. du composant qui a pour class `.a-info` :
 - création du .twig : `web/twig/site/component/1-atom/a-info.twig`
 - création du .scss : `web/style/site/5-component/1-atom/_a-info.scss`
 
-# Mise à jour de version
+---
+
+# Mise à jour de version officiel du projet
 
 A chaque mise à jour de version :
+- Modèle : X:Y:Z (ex: 1.9.0)
 - Mettre à jour la date de livraison et le numéro de version sur la page `index.twig`
 - Lister tous les nouveaux éléments et les modifications apportées par la version sur la page `sg-versions.twig`
 - Lancer la commande `fin gulp` pour générer tous les fichiers puis zipper la version (les éléments du dossier `web/styleguide`) **en retirant les .zip des anciennes versions du dossier /zip**
 - Placer le nouveau fichier .zip dans le dossier `web/src/zip`
 - Vérifier le poids noté dans les twig de tous les fichiers zip. Vous obtiendrez ces informations dans la console en lançant la commande `fin gulp` (fonction zipSizes)
-- Taguer la branch `develop` à chaque livraison de version
+- Taguer la branch `develop` à chaque livraison de version
+
+# Déploiement vers le GitHub ANS
+
+Après que le tag ai été validé par l'ANS sur les environnement OVH (préprod ou prod)
+- Créer une MR de develop au niveau du tag vers la branche "synchro-github-ans"
+- Le push vers github se fait via un job "synchro_github" manuel.