From 1b5bf25f9cf7cac2e2e4c5d8497bba7a8a71e73b Mon Sep 17 00:00:00 2001
From: Arnaud Levy <contact@arnaudlevy.com>
Date: Thu, 20 Jan 2022 11:03:03 +0100
Subject: [PATCH] doc
---
docs/{dev/rd => _rd}/action_text.md | 0
docs/benchmark.md | 6 +++--
docs/communication/models.md | 8 ++++---
docs/{ => education}/rncp/README.md | 0
docs/profile/readme.md | 8 -------
docs/readme.md | 29 +++++++----------------
docs/research/{models.md => readme.md} | 30 ++++++++++++------------
docs/{dev => }/setup.md | 0
docs/{models.md => university/readme.md} | 27 +++++++++------------
docs/user/readme.md | 15 ++++++++++++
10 files changed, 59 insertions(+), 64 deletions(-)
rename docs/{dev/rd => _rd}/action_text.md (100%)
rename docs/{ => education}/rncp/README.md (100%)
delete mode 100644 docs/profile/readme.md
rename docs/research/{models.md => readme.md} (79%)
rename docs/{dev => }/setup.md (100%)
rename docs/{models.md => university/readme.md} (62%)
create mode 100644 docs/user/readme.md
diff --git a/docs/dev/rd/action_text.md b/docs/_rd/action_text.md
similarity index 100%
rename from docs/dev/rd/action_text.md
rename to docs/_rd/action_text.md
diff --git a/docs/benchmark.md b/docs/benchmark.md
index 3f2a2a7bb..94e442e84 100644
--- a/docs/benchmark.md
+++ b/docs/benchmark.md
@@ -1,11 +1,13 @@
# Benchmark
-## Excellent websites
+## Ecoles
+
+### Excellent websites
- https://www.harvard.edu/
- https://www.mit.edu/
-## Other websites
+### Other websites
- https://www.stanford.edu/
- https://www.brown.edu/
diff --git a/docs/communication/models.md b/docs/communication/models.md
index 6f499c5c6..7493cdb6a 100644
--- a/docs/communication/models.md
+++ b/docs/communication/models.md
@@ -1,6 +1,8 @@
-# Models
+# Communication
-## communication/website/Event
+## Models
+
+### communication/website/Event
- university:references
- communication_website:references
@@ -11,7 +13,7 @@
- published:boolean
- published_at:datetime
-## communication/website/event/Kind
+### communication/website/event/Kind
- university:references
- communication_website:references
diff --git a/docs/rncp/README.md b/docs/education/rncp/README.md
similarity index 100%
rename from docs/rncp/README.md
rename to docs/education/rncp/README.md
diff --git a/docs/profile/readme.md b/docs/profile/readme.md
deleted file mode 100644
index 1b8bb4f8f..000000000
--- a/docs/profile/readme.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# Profile
-
-Users can manage their profiles as:
-- teachers
-- students
-- alumni
-
-https://www.iut.u-bordeaux-montaigne.fr/mon-compte
diff --git a/docs/readme.md b/docs/readme.md
index eab5e1a53..0fc5a2994 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -8,7 +8,7 @@ https://bordeauxmontaigne.osuny.org/journal -> workflow publication et review re
https://bordeauxmontaigne.osuny.org/profile -> gestion de son propre profil
-Il ne doit pas y avoir de couplage fort avec osuny.org dans le code (variables d'env dans models/university/with_idenfier.rb).
+Attention, il ne faut pas coder de couplage fort avec osuny.org (utiliser des variables d'env dans models/university/with_idenfier.rb).
On a des objets attachés à l'université "bordeauxmontaigne" :
- ecoles
@@ -21,27 +21,16 @@ On a des objets attachés à l'université "bordeauxmontaigne" :
## Sites
-On peut créer des sites autonomes.
-
1. Choix du about
-Au moment de la création on choisit un about (à terme peut-être plusieurs).
+Au moment de la création on choisit un "about".
Cet "about" peut concerner une université, une école, une revue, ou rien du tout (ex: site de projet étudiant)...
-2. Choix des langues
-Français par défaut
-
-3. Définition du repository
-Sélection du repository git avec le site en Jekyll.
-On peut imaginer le schéma par défaut suivant :
-https://github.com/osuny-org/bordeauxmontaigne-iut
-Ou bien des repositories spécifiques gérés par l'Université.
-
-4.1 Création du repo
-Si le repo n'existe pas, création depuis un template, par exemple :
-https://github.com/osuny-org/school
+2. Définition du repository
+Sélection du repository git avec le site Hugo.
+Ex: https://github.com/noesya/bordeauxmontaigne-iut
-4.2 Sélection du repo
-Si le repo existe, connexion au repository.
+3. Edition du site
+Gestion des objets côté Rails, export statique à l'enregistrement.
-5. Edition du site
-Idem Netlify CMS, passerelle git, création des pages en fonction des collections disponibles et publication sur le git. Certains objets (formations) devront exister en BDD et être transformés en markdown ou html.
+4. Paramétrage
+Définition des langues, adaptation des chemins et des textes pour chaque langue.
diff --git a/docs/research/models.md b/docs/research/readme.md
similarity index 79%
rename from docs/research/models.md
rename to docs/research/readme.md
index 511771b38..30e0c0348 100644
--- a/docs/research/models.md
+++ b/docs/research/readme.md
@@ -1,12 +1,12 @@
-# Models
+## Models
-## university/person/Researcher (extends university/Person)
+### university/person/Researcher (extends university/Person)
... ajouté à university/Person
- habilitation:boolean
- tenure:boolean
-## research/Laboratory
+### research/Laboratory
- university:references
- name:string
@@ -15,7 +15,7 @@
- city:string
- country:string
-## research/laboratory/Axis
+### research/laboratory/Axis
- university:references
- research_laboratory:references
@@ -24,17 +24,7 @@
- description:text
- text:html
-## research/laboratory/Involvement
-
-- university:references
-- research_laboratory:references
-- university_person:references
-- research_axis:references
-- status:enum (statutaire, doctorant, associé)
-- description:string
-- themes:html
-
-## research/Thesis
+### research/Thesis
- university:references
- research_laboratory:references
@@ -45,3 +35,13 @@
- started_at:date
- completed:boolean
- completed_at:date
+
+### research/laboratory/Involvement (tbc)
+
+- university:references
+- research_laboratory:references
+- university_person:references
+- research_axis:references
+- status:enum (statutaire, doctorant, associé)
+- description:string
+- themes:html
diff --git a/docs/dev/setup.md b/docs/setup.md
similarity index 100%
rename from docs/dev/setup.md
rename to docs/setup.md
diff --git a/docs/models.md b/docs/university/readme.md
similarity index 62%
rename from docs/models.md
rename to docs/university/readme.md
index 18f5df146..6d1b51fab 100644
--- a/docs/models.md
+++ b/docs/university/readme.md
@@ -1,6 +1,12 @@
-# Models
+# University
-## University
+## Models
+
+### university/Person
+
+### university/person/Teacher
+
+### University
- name:string
- address:string
@@ -9,7 +15,7 @@
- country:string
- private:boolean
-## university/School
+### university/School
- university:references
- name:string
@@ -20,7 +26,7 @@
- latitude:float
- longitude:float
-## university/Campus
+### university/Campus
- university:references
- name:string
@@ -29,19 +35,8 @@
- city:string
- country:string
-## university/Section
+### university/Section
cf https://conseil-national-des-universites.fr/cnu/
- name:string
- number:integer
-
-## User
-
-- university:references
-- first_name:string
-- last_name:string
-- role:integer (enum: superadmin, admin, visitor)
-
-## university/Person
-
-## university/person/Teacher
diff --git a/docs/user/readme.md b/docs/user/readme.md
new file mode 100644
index 000000000..e3e46ccad
--- /dev/null
+++ b/docs/user/readme.md
@@ -0,0 +1,15 @@
+# User
+
+Users can manage their profiles as:
+- teachers
+- students
+- alumni
+
+https://www.iut.u-bordeaux-montaigne.fr/mon-compte
+
+## Model
+
+- university:references
+- first_name:string
+- last_name:string
+- role:integer (enum: superadmin, admin, visitor)
--
GitLab