From 85a594096d32e233e38529c9dfd70569c86ee776 Mon Sep 17 00:00:00 2001 From: Arnaud Levy <contact@arnaudlevy.com> Date: Tue, 15 Feb 2022 10:37:54 +0100 Subject: [PATCH] doc --- docs/communication/websites/blocks.md | 4 ++-- docs/communication/websites/customs.md | 24 +++++++++++++++++++++--- docs/communication/websites/export.md | 2 +- docs/communication/websites/import.md | 2 +- docs/communication/websites/prototype.md | 24 ------------------------ docs/communication/websites/templates.md | 12 ++++++------ docs/readme.md | 8 ++++---- 7 files changed, 35 insertions(+), 41 deletions(-) delete mode 100644 docs/communication/websites/prototype.md diff --git a/docs/communication/websites/blocks.md b/docs/communication/websites/blocks.md index 0f74062a5..626779b0f 100644 --- a/docs/communication/websites/blocks.md +++ b/docs/communication/websites/blocks.md @@ -25,7 +25,7 @@ Pour commencer, les valeurs de l'enum seront : ### Partial about Un partial que l'on peut ajouter à un show d'objet, avec : - la liste des blocs utilisés (avec boutons show et edit) -- la possibilité de les sort +- la possibilité de les ordonner (position) - un bouton pour ajouter un bloc ``` @@ -45,7 +45,7 @@ views/admin/communication/website/blocks/templates/partners/_edit.html.erb ``` ### Concern -Tous les objets ayant des blocs utilisent le concern `WithBlocks`, qui ajoute la méthode suivante `blocks` (la liste des blocs, dans l'ordre). +Tous les objets ayant des blocs utilisent le concern `WithBlocks`, qui ajoute la méthode `blocks` (la liste des blocs, dans l'ordre). ### Export statique Les blocs sont exportés dans le frontmatter grâce au partial diff --git a/docs/communication/websites/customs.md b/docs/communication/websites/customs.md index 7f506fdad..6dad14a7c 100644 --- a/docs/communication/websites/customs.md +++ b/docs/communication/websites/customs.md @@ -1,7 +1,19 @@ # Customs -## communication/website/custom/Type +Au-delà des pages et des actualités, les sites ont souvent besoin d'objets spécifiques, au cas par cas. +Le site https://www.osuny.org/ présente des fonctionnalités, avec un statut. +Le site https://cyberneticproject.eu/ présente des fiches techniques, avec des synonymes, des téléchargements, un récapitulatif, des références bibliographiques... + +Afin de permettre cette souplesse, nous utilisons des types personnalisés (custom types). +Le type définit une nouvelle sorte d'objets (ex: feature, technical_sheet...). +Chaque type a des propriétés (title, description, summary, status, references...), qui génèrent un formulaire à la volée. +Le type s'ajoute au menu du site, et permet de créer des éléments. +Les éléments s'exportent en statique en utilisant la structure définie par les propriétés. + +## Modèles + +communication/website/custom/Type - university:references - website:references - name:string @@ -11,17 +23,23 @@ - tree:boolean - date:boolean -## communication/website/custom/type/Property +Si order est true, les éléments de ce type peuvent être classés par position (js sortable). +Si tree est true, les éléments peuvent être organisés en arbre, avec des parents et des enfants. +Si date est true, les élément peuvent être publiés à une date donnée. + + +communication/website/custom/type/Property - university:references - website:references - type:references - name:string +- identifier:string - kind:integer (enum) - position -## communication/website/custom/Element +communication/website/custom/Element - university:references - website:references - type:references diff --git a/docs/communication/websites/export.md b/docs/communication/websites/export.md index 2af108bcd..efc0e03e9 100644 --- a/docs/communication/websites/export.md +++ b/docs/communication/websites/export.md @@ -1,4 +1,4 @@ -# Export +# Export Hugo ## Contexte diff --git a/docs/communication/websites/import.md b/docs/communication/websites/import.md index 2e2127707..50f270657 100644 --- a/docs/communication/websites/import.md +++ b/docs/communication/websites/import.md @@ -1,4 +1,4 @@ -# Import +# Import WordPress ## Contexte diff --git a/docs/communication/websites/prototype.md b/docs/communication/websites/prototype.md deleted file mode 100644 index f051d83fc..000000000 --- a/docs/communication/websites/prototype.md +++ /dev/null @@ -1,24 +0,0 @@ -# Static website - -## Prototype - -### Etapes - -- [x] Gestion journal admin -- [x] Gestion volume admin -- [x] Gestion article admin -- [x] Gestion site -- [x] Définir about (éventuellement à la main) -- [ ] Création du repo github -> pas nécessaire, fait par le dev -- [ ] Copie du template -> pas nécessaire, fait par le dev -- [ ] Lecture d'une collection depuis github -> finalement descendant depuis la DB -- [x] Ecriture d'un fichier dans github -- [x] Hébergement Netlify ou autre - -### Points à vérifier - -- [x] Lecture écriture Github -- [x] Performance avec un backend Github -> mauvaise -> DB -- [x] Relations avec les auteurs et les droits (doublon DB, autre...) -> full DB -- [x] Articulation avec les objets en DB (volumes et articles par ex.) -- [x] Gestion des mises à jour des templates -> utiliser un template Github diff --git a/docs/communication/websites/templates.md b/docs/communication/websites/templates.md index 2e5c84061..1d03ffb13 100644 --- a/docs/communication/websites/templates.md +++ b/docs/communication/websites/templates.md @@ -1,17 +1,17 @@ # Templates -## Template de tous les sites +## Thème -https://github.com/osuny-org/template +https://github.com/noesya/osuny-hugo-theme -## Templates de tous les journaux +## Template -https://github.com/osuny-org/template-journal +https://github.com/noesya/osuny-hugo-template Pour faire la mise à jour : ``` -git remote add template git@github.com:osuny-org/template.git +git remote add template git@github.com:noesya/osuny-hugo-template.git git fetch --all git merge template/master --allow-unrelated-histories ``` @@ -23,7 +23,7 @@ https://github.com/osuny-org/clermontauvergne-journal-degrowth Pour faire la mise à jour : ``` -git remote add template git@github.com:osuny-org/template-journal.git +git remote add template git@github.com:noesya/osuny-hugo-template.git git fetch --all git merge template/master --allow-unrelated-histories ``` diff --git a/docs/readme.md b/docs/readme.md index 0fc5a2994..0ec72b5dc 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -2,10 +2,10 @@ ## Domaines -https://bordeauxmontaigne.osuny.org/admin -> admin -https://bordeauxmontaigne.osuny.org/alumni -> webservice des alumni, accessible en iframe -https://bordeauxmontaigne.osuny.org/journal -> workflow publication et review revue scientifique -https://bordeauxmontaigne.osuny.org/profile -> gestion de son propre profil +- https://bordeauxmontaigne.osuny.org/admin -> admin +- https://bordeauxmontaigne.osuny.org/alumni -> webservice des alumni, accessible en iframe +- https://bordeauxmontaigne.osuny.org/journal -> workflow publication et review revue scientifique +- https://bordeauxmontaigne.osuny.org/profile -> gestion de son propre profil Attention, il ne faut pas coder de couplage fort avec osuny.org (utiliser des variables d'env dans models/university/with_idenfier.rb). -- GitLab