update doc

README.md

@@ -2,15 +2,14 @@
 | --- | --- |
 | ot_core | [![pipeline status](http://gitlab.2iopenservice.com/opentalent/ot_typo3/badges/unittests/pipeline.svg)](http://gitlab.2iopenservice.com/opentalent/ot_typo3/-/commits/unittests) [![coverage report](http://gitlab.2iopenservice.com/opentalent/ot_typo3/badges/unittests/coverage.svg)](http://gitlab.2iopenservice.com/opentalent/ot_typo3/-/commits/unittests) |
 
+**[Voir la documentation](/doc/index.md)**
 
 ## Opentalent extensions for Typo3
 
-Pour plus d'informations: [consulter la documentation](/doc)
-
 ### Pré-requis:
 
 * php 7.4
-* Typo3 v9.5 (en mode composer)
+* Typo3 v10.4 (en mode composer)
 
 ### Les extensions
 

doc/ci.md

@@ -1 +1,19 @@
 # Intégration et déploiement continu
+
+L'intégration continue est exécutée par notre instance [Gitlab](https://gitlab.2iopenservice.com/)
+
+On peut consulter l'état de la CI à cette adresse: <https://gitlab.2iopenservice.com/opentalent/admin/-/pipelines>
+
+### Fonction actuelle
+
+Son rôle actuel est d'exécuter [les test](tests.md) implémentés au niveau de chaque extension à chaque fois
+qu'un nouveau push est effectué sur le dépot.
+
+
+### Fonctions futures
+
+A l'avenir, on pourra envisager:
+
+* l'intégration du git flow à la CI
+* le déploiement automatisé en cas de réussite des tests
+* l'exécution manuelle après une mise à jour du core typo3 ou des autres extensions utilisées

doc/dependencies.md

@@ -1,17 +1,24 @@
 # Extensions tierces et dépendances
 
-L'instance Typo3 installée dépend essentiellement des extensions et librairies suivantes:
+L'instance Typo3 installée dépend des extensions et librairies suivantes:
 
 ## Extensions Typo3
 
 ### Fluid
+
+Fluid est un moteur de templating intégré de façon native à typo3 depuis la version 9.
+
 ### VHS
+
+VHS est une extension fournissant un grand nombre de viewhelpers utilisables dans les templates
+fluid.
+
 ### Flux
+
+Flux permet de configurer le comportement des templates fluid du côté du backend.
+
 ### News
 
-## Autres dépendances
+Cette extension permet aux administrateurs de site de maintenir un système d'actualités.
+
 
-### SCSS
-### JQuery
-### Openstreetmap
-### Matomo

doc/index.md

@@ -0,0 +1,33 @@
+# OtTypo: Extensions Typo3 par Opentalent
+
+Typo3 est un [CMS opensource](https://typo3.fr/) adapté à la gestion d'une arborescence de sites.
+
+En 2021, l'usine à site Opentalent héberge près de 3800 sites internet (soit 63600 pages),
+plus environ 2000 sites archivés.
+
+## Sommaire
+
+[Introduction](intro.md)
+
+#### L'installation Typo3
+
+1. [Description de l'installation](installation.md)
+2. [La base de données](db.md)
+3. [Extensions tierces utilisées](dependencies.md)
+4. [Opérations de maintenance (à compléter)](maintenance.md)
+5. [Les tests](tests.md)
+6. [Intégration continue (CI)](ci.md)
+7. [Le container Docker](docker.md)
+8. [Problèmes courants et résolution](faq.md)
+
+#### Concepts et principes amenés par les extensions
+
+1. [Le concept de Websites](ot_websites.md)
+2. [Fonctionnement attendu de l'authentification et mise en oeuvre](auth.md)
+3. [Droits des administrateurs / éditeurs et mise en oeuvre](be_users.md)
+4. [Système de templating](templating.md)
+5. [Les formulaires](forms.md)
+6. [Reception des hooks depuis le logiciel](hooks.md)
+7. [Routage et optimisation](routing.md)
+8. [Intégration des réseaux sociaux (à compléter)](social_networks.md)
+9. [Statistiques d'utilisation des sites](stats.md)

doc/installation.md

@@ -7,12 +7,12 @@ Typo3 est installé sur prod-front et sur preprod en double instance:
 | --- | --- | --- |
 | vhost | 001-sub.opentalent.fr.conf | 001-opentalent.fr.conf |
 | php | 7.4 | 7.0 |
-| Version Typo3 | 9.5 | 8.7 |
+| Version Typo3 | 10.4 | 8.7 |
 | source directory | /var/www/typo3 | /var/www/typo3_82 |
 | Url du backend | https://ohcluses.opentalent.fr/typo3/ | https://opentalent.fr/typo3/ |
 
 
-**Important: Pour la suite de cette documentation, on ne parlera plus que de l'installation la plus récente (v9.5)**
+**Important: Pour la suite de cette documentation, on ne parlera plus que de l'installation la plus récente (v10.4)**
 
 
 Les [extensions Opentalent](..) sont installées dans: `/var/opentalent/git/ot_typo3`

doc/readme.md → doc/intro.md

@@ -1,19 +1,4 @@
-# Typo3
-
-Typo3 est un [CMS opensource](https://typo3.fr/) adapté à la gestion d'une arborescence de sites.
-
-En 2021, l'usine à site Opentalent héberge près de 3800 sites internet (soit 63600 pages), 
-plus environ 2000 sites archivés.
-
-**Sommaire**
-
-* [Détails de l'installation et opérations courantes](installation.md)
-* [Versions et dépendances](dependencies.md)
-* [Backend users: droits des administrateurs et des éditeurs](be_users.md)
-* [Optimisation de la résolution d'url](routing.md)
-* [Gestion des formulaires](forms.md)
-
-
+# Introduction
 
 ## Objectifs
 

doc/maintenance.md

@@ -2,4 +2,11 @@
 
 ## Opérations manuelles
 
+#### Mise à jour du core Typo3
+
+
+#### Mise à jour des extensions tierces
+
+
+
 ## Opérations automatisées

doc/shared_frames.md

@@ -1,25 +0,0 @@
-
-# Frames partagées
-
-Certains cadres sont partagés entre différents templates ou utilisés en tant qu'iframes par des
-sites externes.
-
-Exemple: la recherche des structures adhérentes à une fédération.
-
-### Principe de fonctionnement
-
-#### Template
-
-Les pages en question se voient affecter un template dédié.
-Ce template ne doit pas être disponible au choix pour les utilisateurs des sites.
-
-#### Le paramètre organization-id
-
-Ces templates doivent accepter un paramètre 'organization-id' au niveau de l'url, qui remplace l'organization id 
-habituellement issu de la table `ot_website` pour les sites classiques.
-
-#### Le site Frames
-
-Un site dédié, nommé 'frames', est créé dans Typo3. 
-Chaque iframe correspond à une page de ce site.
-

doc/tests.md

@@ -1 +1,21 @@
 # Tests automatisés
+
+## Tests unitaires
+
+Les tests unitaires sont effectués grâce à l'utilitaire [phpunit](https://phpunit.readthedocs.io/fr/latest/index.html)
+
+Des tests unitaires sont maintenus pour l'extension ot_core seulement. 
+Les autres extensions ne sont pas adaptées à de tels tests, qui seraient très
+difficiles à mettre en place et n'apporteraient pas de réelle plus-value.
+
+## Tests fonctionnels (à venir)
+
+Des tests fonctionnels pourront être implémentés pour valider le fonctionnement global de l'installation typo3.
+Par souci de clarté, ils pourront malgré tout être implémentés extension par extension.
+
+## Scan global
+
+Un scan global pourra être programmé de manière régulière grâce à l'utilitaire [typo3scan](https://gitlab.2iopenservice.com/) 
+afin de détecter d'éventuels problèmes.
+
+> Voir [Maintenance](maintenance.md)

doc/todo.md

@@ -1 +0,0 @@
-