From d6462fcf7f2b8c3b90914f97c89cac59363e66b3 Mon Sep 17 00:00:00 2001 From: reminec <2b0cfddf-5ce0-4693-a420-a6df4afdb1fe@users.tedomum.net> Date: Mon, 20 Mar 2023 13:30:54 +0100 Subject: [PATCH 1/5] [ADR] StaticCms Co-Authored-By: Trollune --- docs/developpement/spec/adr.StaticCms.md | 101 +++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 docs/developpement/spec/adr.StaticCms.md diff --git a/docs/developpement/spec/adr.StaticCms.md b/docs/developpement/spec/adr.StaticCms.md new file mode 100644 index 0000000..cf8d402 --- /dev/null +++ b/docs/developpement/spec/adr.StaticCms.md @@ -0,0 +1,101 @@ +# Proposer une interface de backoffice qui gère le stockage via un repo git + +[TOC] + +## Décision +* Statut: Accepté +* Décideurs: reminec, Trollune +* Date: 2023-03-19 + + +## Contexte et Description du Problème +* La nécessité de ne pas stocker le contenu dans une bdd, mais en fichiers accessibles à des humains. +* La nécessité d'éditer du contenu via une interface Web plutôt que directement dans la forge logiciel. +* La nécessité d'utiliser une forge logiciel : + * Journalisée + * Décentralisée + * Asynchrone + * Collaborative + * Relecture +* La nécessité de ne pas à avoir installer le projet sur les postes des collaboratrices. + + +## Éléments moteurs de la décision +* Possible expertise de nos voisins 2fleurs. +* Ne pas refaire les formulaire web pour saisir et valider du contenu. +* Ne pas refaire la couche de stockage qui dialogue avec une forge logiciel. +* Découplé le backoffice du moteur qui génère les fichiers statiques. + + +## Options considérées +1. [StaticCms](https://staticcms.org) +2. [Grav](https://getgrav.org) + + +## Décision prise +Nous avons choisi l'option `StaticCms` car il semble répondre précisement à nos impératifs. + + +### Conséquences Positives +* Montée en compétences sur une architecture JAMStack. +* Découple le backoffice de l'API. +* Possibilité de partager la connaissance et les embuches avec notre voisin 2fleurs. + +### Conséquences Négatives +* Incertitudes concernant les possibles. +* Montée en compétence potentiellement consommatrice de temps et d'énergie. +* Potentiellement des embûches à prévoir vu la jeunesse du projet. + + +## Les Pour et Contre des Options + +### StaticCms + +#### Pour +* Découple le backoffice du moteur qui construit les fichiers statique. +* Livre des composant d'interfaces apparement prêt à l'emploi. +* Semble compatible avec la plupart des forges logiciels. + +#### Contre +* Le nom générique n'inspire pas confiance à reminec :) +* Le support de Gitea encore en Beta. +* Le projet semble relativement récent. + + +### Grav + +#### Pour +* Propulsé par Symfony, environnement connu par le porteur du projet +* Projet peut-être plus mature du fait de son ancienneté. +* Plugin pour git (git-sync) + +#### Contre +* Grav ajoute des galères sur les fichiers générés du à son formatage de YAML. +* Ne respecte pas l'architecture JAM : C'est Grav qui va porter + * la couche 'backoffice' + * ainsi que la transformation du contenu en fichier statique + + +## Liens +### Voir plus loin +#### Patron de conception ADR +* https://adr.github.io + + +## Licenses + +CC-BY-SA + +### Auteurices +* Trollune +* reminec @ acides.org (Tedomum.net) + +_Librement traduit depuis adr.github.io_ + +#### Versions +##### v1.0.0 +_Date : 17 mars 2023 | Temps rédaction : 1h_ | Trollune, reminec + +## Remerciements +* PierreO. @ indyHosters - Qui nous a soufflé ce patron de conception. +* Quentin @ deuxfleurs - Qui a publié et communiqué ses travaux autour de StaticCms. From 30587063583ca9c98e057de59e92cb3d2dacd36b Mon Sep 17 00:00:00 2001 From: reminec <2b0cfddf-5ce0-4693-a420-a6df4afdb1fe@users.tedomum.net> Date: Mon, 20 Mar 2023 14:14:16 +0100 Subject: [PATCH 2/5] =?UTF-8?q?[FIX]=20Caract=C3=A8re=20invisible?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/developpement/spec/adr.StaticCms.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developpement/spec/adr.StaticCms.md b/docs/developpement/spec/adr.StaticCms.md index cf8d402..8d3f1c0 100644 --- a/docs/developpement/spec/adr.StaticCms.md +++ b/docs/developpement/spec/adr.StaticCms.md @@ -1,4 +1,4 @@ -# Proposer une interface de backoffice qui gère le stockage via un repo git +# Proposer une interface de backoffice qui gère le stockage via un repo git [TOC] From a6f3d41304340195c66c3ab072bd91ac1282a3a1 Mon Sep 17 00:00:00 2001 From: reminec Date: Mon, 3 Apr 2023 22:31:26 +0200 Subject: [PATCH 3/5] Ajout credit --- docs/developpement/spec/adr.StaticCms.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/developpement/spec/adr.StaticCms.md b/docs/developpement/spec/adr.StaticCms.md index 8d3f1c0..4a38e13 100644 --- a/docs/developpement/spec/adr.StaticCms.md +++ b/docs/developpement/spec/adr.StaticCms.md @@ -65,12 +65,12 @@ Nous avons choisi l'option `StaticCms` car il semble répondre précisement à n ### Grav #### Pour -* Propulsé par Symfony, environnement connu par le porteur du projet +* Propulsé par Symfony, environnement connu par @reminec * Projet peut-être plus mature du fait de son ancienneté. * Plugin pour git (git-sync) #### Contre -* Grav ajoute des galères sur les fichiers générés du à son formatage de YAML. +* Grav ajouterait des galères sur les fichiers générés du à son formatage de YAML. * Ne respecte pas l'architecture JAM : C'est Grav qui va porter * la couche 'backoffice' * ainsi que la transformation du contenu en fichier statique @@ -84,11 +84,11 @@ Nous avons choisi l'option `StaticCms` car il semble répondre précisement à n ## Licenses -CC-BY-SA +[CC BY-SA 2.0 FR](https://creativecommons.org/licenses/by-sa/2.0/fr/) ### Auteurices * Trollune -* reminec @ acides.org (Tedomum.net) +* reminec 🤪 | 🧪 [ACIDES.org](https://acides.org) 🏴‍☠️🌈 ([Tedomum.net](https://tedomum.net)) _Librement traduit depuis adr.github.io_ @@ -97,5 +97,5 @@ _Librement traduit depuis adr.github.io_ _Date : 17 mars 2023 | Temps rédaction : 1h_ | Trollune, reminec ## Remerciements -* PierreO. @ indyHosters - Qui nous a soufflé ce patron de conception. -* Quentin @ deuxfleurs - Qui a publié et communiqué ses travaux autour de StaticCms. +* [PierreO](https://mastodon.indie.host/@pierreozoux). @ indyHosters - Qui nous a soufflé ce patron de conception. +* [Quentin @ deuxfleurs - Qui a publié et communiqué ses travaux autour de StaticCms](https://quentin.dufour.io/blog/2023-02-28/staticcms-une-autre-approche-aux-cms/). From 8b05ccd20df778a6996a9c575d1bbaa3c3c7f2dc Mon Sep 17 00:00:00 2001 From: reminec Date: Mon, 3 Apr 2023 22:33:01 +0200 Subject: [PATCH 4/5] Rename location --- .../{spec/adr.StaticCms.md => decisions/005-StaticCms.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/developpement/{spec/adr.StaticCms.md => decisions/005-StaticCms.md} (100%) diff --git a/docs/developpement/spec/adr.StaticCms.md b/docs/developpement/decisions/005-StaticCms.md similarity index 100% rename from docs/developpement/spec/adr.StaticCms.md rename to docs/developpement/decisions/005-StaticCms.md From e72a5cb6bd77661b6aa755b94b1bb6567ac9c21d Mon Sep 17 00:00:00 2001 From: reminec Date: Mon, 3 Apr 2023 22:54:03 +0200 Subject: [PATCH 5/5] drop [TOC] --- docs/developpement/decisions/005-StaticCms.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/developpement/decisions/005-StaticCms.md b/docs/developpement/decisions/005-StaticCms.md index 4a38e13..860c849 100644 --- a/docs/developpement/decisions/005-StaticCms.md +++ b/docs/developpement/decisions/005-StaticCms.md @@ -1,7 +1,5 @@ # Proposer une interface de backoffice qui gère le stockage via un repo git -[TOC] - ## Décision * Statut: Accepté * Décideurs: reminec, Trollune