Merge pull request #107 from studoo-app/main

Update Docs
studoo-app · Jun 24, 2024 · f5cfae2 · f5cfae2
2 parents 2a148a1 + 14bef26
commit f5cfae2
Show file tree

Hide file tree

Showing 6 changed files with 76 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 [![Total Downloads](https://poser.pugx.org/studoo/edu-framework/downloads)](https://packagist.org/packages/studoo/edu-framework)
 [![License](https://poser.pugx.org/studoo/edu-framework/license)](https://packagist.org/packages/studoo/edu-framework)
 
-Le projet "Edu Framework" vise à répondre à une problématique récurrente identifiée lors de nos formations : "Comment faire une transition vers une framework Symfony ?".
+Le projet "Edu Framework" vise à répondre à une problématique récurrente identifiée lors de nos formations : "Comment faire une transition vers un framework Symfony ?".
 
 L'objectif principal "Edu Framework" est de fournir un ensemble d'outils, de guides et de ressources pédagogiques permettant aux développeurs, qu'ils soient novices ou expérimentés, de faciliter leur transition vers le framework Symfony. Ce projet visera à couvrir les aspects fondamentaux ainsi que les techniques avancées de Symfony, en mettant l'accent sur les meilleures pratiques de développement.
 
@@ -19,14 +19,20 @@ L'objectif principal "Edu Framework" est de fournir un ensemble d'outils, de gui
 
 Pour créer un nouveau projet Edu Framework, vous pouvez utiliser la commande suivante :
 ```bash
-composer create-project studoo/edu-framework my_project_name 2.x-dev
+composer create-project studoo/edu-framework-skeleton my_project_name
 ```
 
 Se rendre dans le dossier du projet :
 ```bash
 cd my_project_name
 ```
 
+Puis, saisir cette commande dans votre terminal :
+
+````Bash 
+composer edu:init
+````
+
 Pour démarrer le serveur de développement, vous pouvez utiliser la commande suivante :
 ```bash
 php bin/edu start
@@ -41,13 +47,12 @@ L'état des pipelines de développement est disponible :
 | Package  | Release | Github actions                                                                                                                                                     |
 | :------- |:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | Edu Framework | main    | [![Run test status](https://github.com/studoo-app/edu-framework/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/studoo-app/edu-framework) |
-| Edu Framework | v2.x    | [![Run test status](https://github.com/studoo-app/edu-framework/actions/workflows/testing.yml/badge.svg?branch=2.x)](https://github.com/studoo-app/edu-framework)  |
 | Edu Framework documentation | main    | [![Deploy](https://github.com/studoo-app/edu-framework-doc/actions/workflows/deploy.yml/badge.svg)](https://github.com/studoo-app/edu-framework-doc)               |
+| Edu Framework | v2.x    | [![Run test status](https://github.com/studoo-app/edu-framework/actions/workflows/testing.yml/badge.svg?branch=2.x)](https://github.com/studoo-app/edu-framework)  |
 
 ## Equipe de développement
 L'équipe de développement du projet "Edu Framework" est composée de développeurs expérimentés et passionnés par l'enseignement et la transmission du savoir. 
-Chaque membre de l'équipe apporte son expertise et son expérience pour créer un outil pédagogique de qualité.
-Un collectif, appelé [Studoo](https://github.com/studoo-app), est né autour de ces projets pour partager des connaissances et des compétences, et pour contribuer à l'amélioration continue des outils pédagogiques.
+Un collectif, appelé [Studoo](https://github.com/studoo-app), est né autour de ces projets pour partager et contribuer à l'amélioration continue des outils pédagogiques.
 
 - **Founder / Lead tech** : [Benoit Foujols](https://github.com/bfoujols)
-- **Lead dev** : [Julien Pechberty](https://github.com/JPechberty)
+- **Lead dev** : [Julien Pechberty](https://github.com/JPechberty)
diff --git a/docs/build/use-case-ville.md b/docs/build/use-case-ville.md
@@ -7,7 +7,9 @@
 Nous allons créer un CRUD pour la gestion des villes.
 
 ## Création de la table
-
+
+Inserez les données suivantes dans votre base de données :
+
 ```sql
 CREATE TABLE ville (
     id INT AUTO_INCREMENT PRIMARY KEY,
@@ -20,6 +22,8 @@ INSERT INTO ville (nom, code_postal, nombre_habitant) VALUES ('Marseille', '1300
 INSERT INTO ville (nom, code_postal, nombre_habitant) VALUES ('Lyon', '69000', 500000);
 ```
 
+Dans la configuration Docker, nous proposons d'utiliser PhpMyAdmin pour gérer la base de données.
+
 ## Création du CRUD
 
 ### Liste des Villes (Read)

diff --git a/docs/index.md b/docs/index.md
@@ -4,9 +4,9 @@
   ![Logo Edu Framework](assets/studoo-framework.svg){ width="500" }
 </figure>
 
-Le projet "Edu Framework" vise à répondre à une problématique récurrente identifiée lors de nos formations : "Comment faire une transition vers une framework Symfony ?".
+Le projet "Edu Framework" vise à répondre à une problématique récurrente identifiée lors de nos formations : "Comment faire une transition vers un framework comme Symfony ? »
 
-L'objectif principal "Edu Framework" est de fournir un ensemble d'outils, de guides et de ressources pédagogiques permettant aux développeurs, qu'ils soient novices ou expérimentés, de faciliter la transition vers le framework Symfony. Ce projet visera à couvrir les aspects fondamentaux, en mettant l'accent sur les meilleures pratiques de développement.
+L'objectif principal "Edu Framework" est de fournir un ensemble d'outils, de guides et de ressources pédagogiques permettant aux développeurs, qu'ils soient novices ou expérimentés, de faciliter la transition vers un framework comme Symfony. Ce projet visera à couvrir les aspects fondamentaux, en mettant l'accent sur les meilleures pratiques de développement.
 
 !!! warning "Information importante"
 
@@ -23,14 +23,20 @@ L'objectif principal "Edu Framework" est de fournir un ensemble d'outils, de gui
 
 Pour créer un nouveau projet Edu Framework, vous pouvez utiliser la commande suivante :
 ```bash
-composer create-project studoo/edu-framework my_project_name 2.x-dev
+composer create-project studoo/edu-framework-skeleton my_project_name
 ```
 
 Se rendre dans le dossier du projet :
 ```bash
 cd my_project_name
 ```
 
+Puis, saisir cette commande dans votre terminal :
+
+````Bash 
+composer edu:init
+````
+
 Pour démarrer le serveur de développement, vous pouvez utiliser la commande suivante :
 ```bash
 php bin/edu start
@@ -46,4 +52,4 @@ L'état des pipelines de développement est disponible :
 |:----------------------------|:--------|:--------------------------------------------------------------------------------------------------------------------|
 | Edu Framework stable        | main    | ![Run test status](https://github.com/studoo-app/edu-framework/actions/workflows/testing.yml/badge.svg?branch=main) |
 | Edu Framework v2            | v2.x    | ![Run test status](https://github.com/studoo-app/edu-framework/actions/workflows/testing.yml/badge.svg?branch=2.x)  |
-| Edu Framework documentation | main    | ![Deploy](https://github.com/studoo-app/edu-framework/actions/workflows/documentation.yml/badge.svg)                |
+| Edu Framework documentation | main    | ![Deploy](https://github.com/studoo-app/edu-framework/actions/workflows/documentation.yml/badge.svg)                |
diff --git a/docs/installation/installation.md b/docs/installation/installation.md
@@ -15,30 +15,21 @@ pwd // pour savoir ou vous êtes dans votre arboresence
 
 Nous allons créer le projet à l'aide du gestionnaire de paquets "composer". Cette étape vous permettra de construire la base du projet en une seule ligne de commande.
 
-Tableau des versions EDU-Framework :
-
-| Version | Etat                           | Date sortie |
-|---------|--------------------------------|-------------|
-| 2.x-dev | stable | 04/2024     |
-| 1.x-dev | stable | 03/2024     |
-
 Saisir cette commande dans votre terminal :
 
 !!! info "Information importante"
 
     Remplacez **NOM_DU_PROJET** par le nom de votre projet
 
-    Remplacez **VERSION** par la version souhaitée (ex : 2.x-dev)
-
 ````Bash
-composer create-project studoo/edu-framework-skeleton NOM_DU_PROJET VERSION
+composer create-project studoo/edu-framework-skeleton NOM_DU_PROJET
 ````
 
 !!! warning "Erreur d'intallation du projet"
 
     Attention, cette commande peut comporter des erreurs si vous n'avez pas installé PHP.
 
-    Voir le chapitre ["Erreur d'intallation du projet"](#)
+    Voir le chapitre ["Erreur d'intallation du projet"](#erreur-dinstallation-des-dependances)
 
 
 !!! note "Exemple d'affichage suite à la commande"

diff --git a/docs/migrate/migration-1_2-2_0.md b/docs/migrate/migration-1_2-2_0.md
@@ -3,7 +3,7 @@
 ## Introduction
 La version 2.0 du framework apporte de nombreuses améliorations et corrections de bugs. \
 Je vous invite à lire attentivement les changements apportés pour migrer votre projet de la version 1.2 à la version 2.0.
-Lien sur la release note : [Release note 2.0](fr-release-edu.md)
+Lien sur la release note : [Release note 2.0](../changelog.md#v200-06042024)
 
 ## Comment migrer ?
 Pour migrer de la version 1.2 à la version 2.0, vous devez suivre les étapes suivantes :
@@ -13,12 +13,12 @@ Pour migrer de la version 1.2 à la version 2.0, vous devez suivre les étapes s
 3. Faire les actions suivantes : 
 
 3.1 **Mettre à jour le fichier composer** :
-```
+```diff
   "require": {
     "php": ">=8.1",
     "ext-mbstring": "*",
 --    "studoo/edu-framework": "1.2.x-dev"
-++    "studoo/edu-framework": "2.0.x-dev"
+++    "studoo/edu-framework": "2.x-dev"
   },
 ```
 
@@ -28,10 +28,10 @@ composer update studoo/edu-framework
 ```
 
 Résultat :
-```
+```bash
 [...]
 Package operations: 0 installs, 1 update, 0 removals
-  - Downloading studoo/edu-framework (2.0.x-dev xxxxx)
+  - Downloading studoo/edu-framework (2.x-dev xxxxx)
   - Upgrading studoo/edu-framework (1.2.x-dev ef385b8 => 2.0.x-dev xxxxx): Extracting archive
 [...]
 ```
@@ -42,8 +42,8 @@ Package operations: 0 installs, 1 update, 0 removals
 ```
 
 Résultat :
-```
-EduFramework v2.0.x-xxxx
+```bash
+EduFramework v2.x-xxxx
 ```
 
 ## Les changements
@@ -63,40 +63,42 @@ composer edu:docker:db-service:stop mysql
 
 2. **Téléchargement du nouveau fichier Docker** :
 
-<tabs>
-    <tab title="WINDOWS">
-        <warning>
-            <p>
-                Ouvrir un terminal git bash à la racine de votre projet
-            </p>
-        </warning>
-        Pour télécharger le fichier compose, suivre les instructions :
-        <code-block lang="Bash">
-        curl -o compose.yaml https://raw.githubusercontent.com/studoo-app/edu-framework/2.0/compose.yaml
-        </code-block>
+=== ":fontawesome-brands-windows: WINDOWS"
+
+    Ouvrir un terminal git bash à la racine de votre projet
+
+    Pour télécharger le fichier compose, suivre les instructions :
+
+    ```bash
+    curl -o compose.yaml https://raw.githubusercontent.com/studoo-app/edu-framework/main/compose.yaml
+    ```
+
+    !!! bug "curl: (35)"
+
         Si vous rencontrez une erreur `curl: (35) schannel: next InitializeSecurityContext failed: Unknown error (0x80092012) - The revocation function was unable to check revocation for the certificate.`
-        <code-block lang="Bash">
-        curl --ssl-no-revoke -o compose.yaml https://raw.githubusercontent.com/studoo-app/edu-framework/2.0/compose.yaml
-        </code-block>
-    </tab>
-    <tab title="MAC OS">
-        <warning>
-            <p>
-                Ouvrir un terminal à la racine de votre projet
-            </p>
-        </warning>
-        Pour télécharger le fichier compose, suivre les instructions :
-        <code-block lang="Bash">
-        curl -sS https://raw.githubusercontent.com/studoo-app/edu-framework/2.0/compose.yaml -o compose.yaml
-        </code-block>
-    </tab>
-</tabs>
+
+        Saisir la commande suivante :
+
+        ```bash
+        curl --ssl-no-revoke -o compose.yaml https://raw.githubusercontent.com/studoo-app/edu-framework/main/compose.yaml
+        ```
+
+=== ":fontawesome-brands-apple: MAC OS"
+
+    Ouvrir un terminal à la racine de votre projet
+
+    Pour télécharger le fichier compose, suivre les instructions :
+
+    ```bash
+    curl -sS https://raw.githubusercontent.com/studoo-app/edu-framework/2.0/compose.yaml -o compose.yaml
+    ```
+
 
 3. **Modifier le nouveau fichier Docker** :
 
 Vous pouvez modifier le fichier `compose.yaml` pour ajuster les paramètres à votre environnement.
 
-```
+```diff
     environment:
       MYSQL_DATABASE: app_db
 --    MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
@@ -107,9 +109,10 @@ Vous pouvez modifier le fichier `compose.yaml` pour ajuster les paramètres à v
       #MYSQL_PASSWORD: app_db_password
 ```
 
-> **Note** : Les commentaires sont ajoutés pour vous aider à comprendre les modifications.
-> Bien respecté la syntaxe YAML pour éviter les erreurs. (indentation, etc.)
-> {style="info"}
+!!! note
+
+    **Note** : Les commentaires sont ajoutés pour vous aider à comprendre les modifications.
+    Bien respecté la syntaxe YAML pour éviter les erreurs. (indentation, etc.)
 
 4. **Démarrer les services** :
 
@@ -119,8 +122,10 @@ docker compose up -d
 
 5. **Supprimer les anciens dossier Docker** :
 
-> Ouvrir un terminal git bash à la racine de votre projet
-> {style="warning"}
+!!! warning "Information importante"
+
+    **Attention** : Avant de supprimer les anciens dossiers Docker, assurez-vous que les services Docker sont bien démarrés.
+    Ouvrir un terminal git bash à la racine de votre projet
 
 ```Bash
 rm -fr docker
@@ -130,7 +135,7 @@ rm -fr docker
 
 > Ouvrir le fichier `composer.json` et supprimer les lignes suivantes :
 
-```
+```diff
   "scripts": {
     "edu:start": [
       "Composer\\Config::disableProcessTimeout",

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,6 +2,7 @@ site_name: Light Education PHP framework
 site_url: https://studoo-app.github.io/edu-framework/
 repo_url: https://github.com/studoo-app/edu-framework
 copyright: 'Copyright © 2022 - 2024 Collectif Studoo'
+edit_uri: edit/main/docs/
 
 theme:
   name: material
@@ -49,6 +50,7 @@ theme:
         icon: material/brightness-4
         name: Switch to system preference
   features:
+    - content.action.edit
     - content.code.copy
     - navigation.footer
     - navigation.instant