Skip to content

Commit 205bb23

Browse files
authored
Merge pull request #42 from ansforge/main-klee
Main klee to main
2 parents ef533f2 + 237b336 commit 205bb23

File tree

9 files changed

+46
-60
lines changed

9 files changed

+46
-60
lines changed

README.md

Lines changed: 41 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,94 @@
11
# ANS - RESSOURCES
2+
23
### Design System de l'ANS
34

45
---
56

67
Framework CSS créé par les équipes front d'Alterway.
78
Maintenu par Klee Interactive.
9+
810
- BEM pour le nommage des class et id
911
- SASS pour le CSS
1012
- jQuery ou Vanilla JS selon le besoin
1113
- Accessibilité : RGAA (AA) exigé
1214
- GULP 4.x.x
1315
- Docksal
1416

15-
## Génération du projet
16-
17-
Pour la première fois
18-
```
19-
fin init
20-
```
21-
22-
Pour recompiler le guide de style
23-
```
24-
fin compile
25-
```
26-
27-
Pour lancer la commande manuellement :
28-
```
29-
fin gulp
30-
```
31-
32-
Pour lancer avec le watcher
33-
```
34-
fin watch
35-
```
36-
37-
### Si le GULP plante
38-
39-
Faire :
40-
```
41-
rm -rf node_modules
42-
rm -rf package-lock.json
43-
fin npm cache clean --force
44-
fin npm install
45-
```
4617
---
18+
4719
# Les grands principes
4820

4921
### Base
22+
5023
- Héritage de Boostrap 4.x.x
5124
- OOCSS et BEM
5225
- Architecture en Atomic Design
5326
- Compilation via Gulp 4.x.x
5427

5528
### Javascript
29+
5630
Les plugins JS sont en jQuery pour la majorité d'entre eux.
5731
Ils respectent les patterns d'accessibilité.
5832

5933
### Accessibilité
34+
6035
Respecter le RGAA, coder de façon accessible tant en HTML (twig), en CSS et en JS.
6136

6237
### Composants
38+
6339
- dossier TWIG des composants : `web/twig/site/component`.
6440
- dossier CSS des composants : `web/style/site/5-component`.
6541

6642
Faire correspondre au maximum les noms de fichiers CSS et TWIG, ainsi que les class du composant.
6743

6844
Ex. du composant qui a pour class `.a-info` :
45+
6946
- création du .twig : `web/twig/site/component/1-atom/a-info.twig`
7047
- création du .scss : `web/style/site/5-component/1-atom/_a-info.scss`
7148

72-
---
49+
### Gestion des css
50+
51+
Le fichier style-ans.css est la feuille de style css principale du site.
52+
53+
Le fichier styleguide.css concerne le guide de style. Il écrase style-ans.css pour des styles spécifiques au site guide de style.
54+
55+
En cas de modification ou de création de composant, il est important donc de modifier les fichiers scss de style/site et non pas style/styleguide.
56+
57+
58+
59+
# Section technique
60+
61+
- Pour la première fois : ```fin init```
62+
- Pour recompiler le guide de style : ```fin compile```
63+
- Pour lancer la commande manuellement : ```fin gulp```
64+
- Pour lancer avec le watcher : ```fin watch```
7365

74-
# Mise à jour de version officiel du projet
66+
67+
- Si le GULP plante :
68+
69+
```
70+
rm -rf node_modules
71+
rm -rf package-lock.json
72+
fin npm cache clean --force
73+
fin npm install
74+
```
75+
76+
## Mise à jour de version officiel du projet
7577

7678
A chaque mise à jour de version :
79+
7780
- Modèle : X:Y:Z (ex: 1.9.0)
7881
- Mettre à jour la date de livraison et le numéro de version sur la page `index.twig`
7982
- Lister tous les nouveaux éléments et les modifications apportées par la version sur la page `sg-versions.twig`
80-
- 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**
81-
- Placer le nouveau fichier .zip dans le dossier `web/src/zip`
83+
- Lancer la commande `fin gulp` pour générer tous les fichiers puis zipper la version (les éléments du dossier `styleguide`) **en retirant les .zip des anciennes versions du dossier styleguide/zip**
84+
- ```cd styleguide && zip -r ../src/zip/ans-design-system-v1.0.1.zip .```
85+
- Vérifier le nouveau fichier .zip dans le dossier `src/zip`
8286
- 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)
8387
- Taguer la branch `develop` à chaque livraison de version
8488

85-
# Déploiement vers le GitHub ANS
89+
## Déploiement vers le GitHub ANS
8690

8791
Après que le tag ai été validé par l'ANS sur les environnement OVH (préprod ou prod)
92+
8893
- Créer une MR de develop au niveau du tag vers la branche "synchro-github-ans"
8994
- Le push vers github se fait via un job "synchro_github" manuel.

src/php/confirmation.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -318,10 +318,6 @@
318318
<a class="nav-link" href="sg-utilities.html">Class utilitaires</a>
319319
</li>
320320

321-
<li class="nav-item common-nav-item">
322-
<a class="nav-link" href="sg-support.html">Support</a>
323-
</li>
324-
325321
<li class="nav-item common-nav-item">
326322
<a class="nav-link" href="sg-versions.html">Versions</a>
327323
</li>

src/style/site/4-structure/__index.scss

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@
1111
@import 'header';
1212
@import 'nav';
1313
@import 'wysiwyg';
14-
@import 'footer';
14+
@import 'footer';
15+
@import 'menu-slide-bar';

src/style/styleguide/4-structure/_menu-slide-bar.scss renamed to src/style/site/4-structure/_menu-slide-bar.scss

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,17 +54,6 @@
5454
width: 100%;
5555
position: relative;
5656
background-color: $white;
57-
58-
@include media-breakpoint-up(lg) {
59-
width: var(--sg-nav-left-width);
60-
position: fixed;
61-
top: 0;
62-
left: 0;
63-
right: 0;
64-
bottom: 0;
65-
z-index: $zindex-fixed;
66-
overflow-y: auto;
67-
}
6857
}
6958

7059
// Optionnal title (DSFR structure)

src/style/styleguide/4-structure/__index.scss

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22
@import 'nav-skip';
33
@import 'header';
44
@import 'nav';
5-
@import 'menu-slide-bar';
65
@import 'wysiwyg';

src/twig/styleguide/page/sg-kit-designers.twig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<div class="wysiwyg">
1818
{% include "../../styleguide/component/2-molecule/m-sg-file.twig" with {
1919
fileIsNotDownload: true,
20-
fileUrl: "/zip/LIBRAIRIE-ANS-SKETCH.zip",
20+
fileUrl: "zip/LIBRAIRIE-ANS-SKETCH.zip",
2121
fileTarget: "_blank",
2222
fileName: "Librairie ANS - Sketch",
2323
} %}

src/twig/styleguide/page/sg-versions.twig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
{% include "../../styleguide/component/2-molecule/m-sg-file.twig" with {
2323
fileUrl: "zip/ans-design-system-v1.0.10.zip",
2424
fileName: "Design System ANS v1.0.10",
25-
fileDate: "14 Ocotbre 2024",
26-
fileWeight: "7.2 Mo",
25+
fileDate: "14 Octobre 2024",
26+
fileWeight: "10.6 MB",
2727
fileType: "ZIP"
2828
} %}
2929
</div>

src/twig/styleguide/structure/_nav-primary.twig

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -324,10 +324,6 @@
324324
text: "Class utilitaires",
325325
link: "sg-utilities.html"
326326
},
327-
{
328-
text: "Support",
329-
link: "sg-support.html"
330-
},
331327
{
332328
text: "Versions",
333329
link: "sg-versions.html"
-6.96 MB
Binary file not shown.

0 commit comments

Comments
 (0)