docs: tutorials

riatelab · Sep 19, 2024 · 69e518c · 69e518c
1 parent ec0bc12
commit 69e518c
Show file tree

Hide file tree

Showing 15 changed files with 61 additions and 12 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -59,8 +59,8 @@ function sidebarFr(): DefaultTheme.SidebarItem[] {
       text: 'Tutoriels',
       collapsed: true,
       items: [
-        // { text: 'Premier pas avec Magrit (données d\'exemple)', link: 'tutorials/tuto1' },
-        { text: 'Premier pas avec Magrit (données personnelles)', link: 'tutorials/tuto2' },
+        { text: 'Premier pas avec Magrit (exemple 1)', link: '/tutorials/tuto1' },
+        { text: 'Premier pas avec Magrit (exemple 2)', link: '/tutorials/tuto2' },
         // { text: 'Utilisation de foncionnalités avancées de Magrit', link: 'tutorials/tuto3' },
         // { text: 'Tutoriel vidéo', link: 'tutorials/video' },
       ],
@@ -131,8 +131,8 @@ function sidebarEn(): DefaultTheme.SidebarItem[] {
       text: 'Tutorials',
       collapsed: true,
       items: [
-        // { text: 'Getting started with Magrit (example dataset)', link: 'tutorials/tuto1' },
-        { text: 'Getting started with Magrit (own dataset)', link: 'tutorials/tuto2' },
+        { text: 'Getting started with Magrit (example 1)', link: '/en/tutorials/tuto1' },
+        { text: 'Getting started with Magrit (example 2)', link: '/en/tutorials/tuto2' },
         // { text: 'Using Magrit advanced features', link: 'tutorials/tuto3' },
         // { text: 'Video tutorial', link: 'tutorials/video' },
       ],

diff --git a/docs/en/tutorials/tuto1.md b/docs/en/tutorials/tuto1.md
@@ -1,3 +1,19 @@
 # Tutorial - Getting started with Magrit
-# Using a sample dataset
+# Example 2: Using a sample dataset
 
+We will create a simple thematic map with Magrit using the sample datasets provided.
+
+This will allow us to discover the basic features of the application (display of the data table, choice of a representation, map styling, and map export)
+without worrying about data retrieval or preparation.
+
+## Step 1: Open the application
+
+There are several ways to access the Magrit application:
+- By using the direct link: [https://magrit.cnrs.fr/app/](https://magrit.cnrs.fr/app/) (also accessible from the "Access the application" button at the top of each page of the documentation),
+- By downloading the application executable corresponding to your platform (Windows, MacOS, Linux) from the application download page: [https://magrit.cnrs.fr/download/](https://magrit.cnrs.fr/download/).
+
+We choose the first option to access the application and therefore go to the URL [https://magrit.cnrs.fr/app/](https://magrit.cnrs.fr/app/).
+
+<!-- Put a screenshot of the application's home page -->
+
+## Step 2: Open a sample dataset
diff --git a/docs/en/tutorials/tuto2.md b/docs/en/tutorials/tuto2.md
@@ -1,5 +1,5 @@
 # Tutorial - Getting started with Magrit
-# Using your own data
+# Example 2: Using Open Data from Grenoble Metropole
 
 We're going to create a simple thematic map with Magrit using your own data.
 

diff --git a/docs/public/tuto1-1.png b/docs/public/tuto1-1.png
diff --git a/docs/public/tuto1-2.png b/docs/public/tuto1-2.png
diff --git a/docs/public/tuto1-3.png b/docs/public/tuto1-3.png
diff --git a/docs/public/tuto1-4.png b/docs/public/tuto1-4.png
diff --git a/docs/public/tuto1-4a.png b/docs/public/tuto1-4a.png
diff --git a/docs/public/tuto1-4b.png b/docs/public/tuto1-4b.png
diff --git a/docs/public/tuto1-4c.png b/docs/public/tuto1-4c.png
diff --git a/docs/public/tuto1-4d.png b/docs/public/tuto1-4d.png
diff --git a/docs/public/tuto1-4e.png b/docs/public/tuto1-4e.png
diff --git a/docs/public/tuto1-4f.png b/docs/public/tuto1-4f.png
diff --git a/docs/tutorials/tuto1.md b/docs/tutorials/tuto1.md
@@ -1,9 +1,42 @@
 # Tutoriel - Premier pas avec Magrit 
-# Utilisation d'un jeu de données d'exemple
-
+# Exemple 1 : Utilisation d'un jeu de données d'exemple
 
 
 Nous allons réaliser une carte thématique simple avec Magrit en utilisant les fonds de carte fournis en exemple.
 
-Cela permettra de découvrir les fonctionnalités de base de l'application (affichage du tableau de données, choix d'une représentation, habillage de la carte et export de la carte).
+Cela permettra de découvrir les fonctionnalités de base de l'application (affichage du tableau de données, choix d'une représentation, habillage de la carte et export de la carte)
+sans se soucier de la récupération ni de la préparation des données.
+
+
+## Étape 1 : Accéder à l'application
+
+Plusieurs manières d'accéder à l'application Magrit sont possibles :
+- En utilisant le lien direct : [https://magrit.cnrs.fr/app/](https://magrit.cnrs.fr/app/) (également accessible depuis le bouton "Accéder à l'application" en haut de chaque page de la documentation),
+- En téléchargeant l'exécutable de l'application correspondant à votre plateforme (Windows, MacOS, Linux) depuis la page de téléchargement de l'application : [https://magrit.cnrs.fr/download/](https://magrit.cnrs.fr/download/).
+
+Nous choisissons la première option pour accéder à l'application et nous nous rendons donc à l'URL [https://magrit.cnrs.fr/app/](https://magrit.cnrs.fr/app/).
+
+<!-- Mettre une capture d'écran de la page d'accueil de l'application -->
+
+## Étape 2 : Ouvrir un jeu de données d'exemple
+
+Pour ouvrir un jeu de données d'exemple, il suffit de cliquer sur le bouton "Explorer les jeux de données d'exemple..." dans le menu de gauche de l'application.
+
+
+
+
+## Étape 3 : Afficher les données attributaires
+
+## Étape 4 : Tester les principaux modes de représentation
+
+### Représentation par symboles proportionnels
+
+### Représentation par carte choroplèthe
+
+### Représentation par carte choroplèthe catégorielle
+
+### Représentation par carte des discontinuités
+
+## Étape 5 : L'habillage et la mise en page de la carte
 
+## Étape 6 : Exporter la carte
diff --git a/docs/tutorials/tuto2.md b/docs/tutorials/tuto2.md
@@ -1,11 +1,11 @@
 # Tutoriel - Premier pas avec Magrit
-# Utilisation de données personnelles
+# Exemple 2 : Utilisation de données de la Métropole de Grenoble
 
-Nous allons réaliser une carte thématique simple avec Magrit en utilisant vos propres données.
+Nous allons réaliser une carte thématique simple avec Magrit en utilisant des données ouvertes, récupérables sur le Web.
 
 Cela permettra de découvrir les fonctionnalités de base de l'application (import des données, réalisation d'une jointure, affichage du tableau de données, choix d'une représentation, habillage de la carte et export de la carte).
 
-Pour cela nous allons réaliser une carte de l'abstention au second tour de l'élection législative de 2022, à Grenoble et par bureau de vote.
+Pour cela, nous allons réaliser une carte de l'abstention au second tour de l'élection législative de 2022, à Grenoble et par bureau de vote.
 
 <ZoomImg
     src="/tuto2-fin.png"