Skip to content

Commit

Permalink
⭐ edit some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
makcimerrr committed Aug 21, 2024
1 parent 93f9c62 commit e2bea76
Show file tree
Hide file tree
Showing 11 changed files with 231 additions and 141 deletions.
77 changes: 38 additions & 39 deletions docs/cogs/event_cog.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,51 @@
# Module de Gestion des Événements
# 🎉 Module de Gestion des Événements

Ce module, intégré au bot Discord Zone01, est responsable de la création et de la gestion des événements au sein du serveur Discord. Il permet aux utilisateurs de s'inscrire à des événements et offre aux administrateurs des outils pour gérer les inscriptions.
Bienvenue dans le module de gestion des événements du **Bot Discord Zone01** ! Ce module permet de créer et de gérer des événements au sein du serveur Discord, offrant aux utilisateurs la possibilité de s'inscrire et aux administrateurs des outils pour gérer les inscriptions. 📅

## Fonctionnalités
## 🌟 Fonctionnalités

### Commande `/create_event`
- **Description** : Cette commande permet aux administrateurs de créer un nouvel événement. Un message avec un embed sera envoyé, contenant les détails de l'événement et les boutons d'interaction pour les utilisateurs et les administrateurs.
- **Utilisation** : `/create_event`
- **Paramètres** :
- `nom_d'événement` : Le nom de l'événement.
- `description` : La description de l'événement
- `date` : La date de l'événement (format JJ/MM/AAAA).
- `heures` : La plage horaire de l'événement (format HH:MM - HH:MM).
- `durée` : La durée de chaque créneau horaire en minutes.
- **Description :** Permet aux administrateurs de créer un nouvel événement. Un message avec un embed sera envoyé, contenant les détails de l'événement et les boutons d'interaction pour les utilisateurs et les administrateurs. 📝
- **Utilisation :** `/create_event`
- **Paramètres :**
- `nom_d'événement` : Le nom de l'événement. 📛
- `description` : La description de l'événement. 📜
- `date` : La date de l'événement (format JJ/MM/AAAA). 📅
- `heures` : La plage horaire de l'événement (format HH:MM - HH:MM).
- `durée` : La durée de chaque créneau horaire en minutes.

### Boutons d'Interaction
### 🔘 Boutons d'Interaction

#### Bouton "S'inscrire" (✅)
- **Description** : Permet aux utilisateurs de s'inscrire à l'événement.
- **Fonctionnement** :
- Lorsqu'un utilisateur clique sur ce bouton, il est ajouté à la liste des participants avec un créneau horaire spécifique.
- Si l'utilisateur est déjà inscrit, un message d'erreur est affiché.
- **Description :** Permet aux utilisateurs de s'inscrire à l'événement. 🖊️
- **Fonctionnement :**
- Lorsqu'un utilisateur clique sur ce bouton, il est ajouté à la liste des participants avec un créneau horaire spécifique. 🗓️
- Si l'utilisateur est déjà inscrit, un message d'erreur est affiché. ⚠️

#### Bouton "Effacer un étudiant" (🗑️)
- **Description** : Permet aux administrateurs de supprimer un utilisateur de la liste des participants.
- **Fonctionnement** :
- Lorsqu'un administrateur clique sur ce bouton, le premier utilisateur de la liste est supprimé.
- Le prochain utilisateur dans la liste est notifié pour son entretien.
- **Description :** Permet aux administrateurs de supprimer un utilisateur de la liste des participants. 🚫
- **Fonctionnement :**
- Lorsqu'un administrateur clique sur ce bouton, le premier utilisateur de la liste est supprimé. 🧹
- Le prochain utilisateur dans la liste est notifié pour son entretien. 📬

#### Bouton "Supprimer l'embed" (🚫)
- **Description** : Permet aux administrateurs de supprimer le message embed de l'événement.
- **Fonctionnement** :
- Lorsqu'un administrateur clique sur ce bouton, le message embed est supprimé et l'événement est effacé de la base de données.
- **Description :** Permet aux administrateurs de supprimer le message embed de l'événement. 🗑️
- **Fonctionnement :**
- Lorsqu'un administrateur clique sur ce bouton, le message embed est supprimé et l'événement est effacé de la base de données.

#### Bouton "Clôturer les inscriptions" (🔒)
- **Description** : Permet aux administrateurs de clôturer les inscriptions pour l'événement.
- **Fonctionnement** :
- Lorsqu'un administrateur clique sur ce bouton, le bouton d'inscription est désactivé, empêchant de nouvelles inscriptions.

### Exemple de Création d'Événement
- **Commande** : `/create_event`
- Réunion Audit Sudoku 15/08/2024 14:00 - 18:00 30
![Create Event](./images/Create_Event.png)
- **Résultat** : Un message embed est créé avec les détails de l'événement et les utilisateurs peuvent commencer à s'inscrire.
![Result Event](./images/Event_Result.png)


### Notes
- Les administrateurs doivent avoir les permissions nécessaires pour utiliser les boutons de gestion.
- Les utilisateurs ne peuvent s'inscrire qu'une seule fois par événement.
- Les créneaux horaires sont calculés automatiquement en fonction de l'heure de début et de la durée spécifiée lors de la création de l'événement.
- **Description :** Permet aux administrateurs de clôturer les inscriptions pour l'événement. 🔐
- **Fonctionnement :**
- Lorsqu'un administrateur clique sur ce bouton, le bouton d'inscription est désactivé, empêchant de nouvelles inscriptions. 🚫

### 📸 Exemple de Création d'Événement
- **Commande :** `/create_event`
- Réunion Audit Sudoku 15/08/2024 14:00 - 18:00 30
![Create Event](./images/Create_Event.png)
- **Résultat :** Un message embed est créé avec les détails de l'événement et les utilisateurs peuvent commencer à s'inscrire. 🎉
![Result Event](./images/Event_Result.png)

### 📋 Notes
- Les administrateurs doivent avoir les permissions nécessaires pour utiliser les boutons de gestion. 🔑
- Les utilisateurs ne peuvent s'inscrire qu'une seule fois par événement. 🚫
- Les créneaux horaires sont calculés automatiquement en fonction de l'heure de début et de la durée spécifiée lors de la création de l'événement. ⏲️
7 changes: 3 additions & 4 deletions docs/gestion_ask_help.md → docs/cogs/gestion_ask_help.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# 🛠️ Documentation de la Commande `/send_embed_help`
# 🛠️ Documentation de la Commande `/send_help_embed`

## Description

La commande `/send_embed_help` permet d'envoyer un message d'aide dans un canal spécifique. Le message inclut un embed avec un bouton pour demander de l'aide. Selon le rôle de l'utilisateur, le message est envoyé dans un canal déterminé.
La commande `/send_help_embed` permet d'envoyer un message d'aide dans un canal spécifique. Le message inclut un embed avec un bouton pour demander de l'aide. Selon le rôle de l'utilisateur, le message est envoyé dans un canal déterminé.

## Utilisation

**Commande :** `/send_embed_help`
**Commande :** `/send_help_embed`

### Paramètres

Expand All @@ -22,4 +22,3 @@ La commande `/send_embed_help` permet d'envoyer un message d'aide dans un canal

```markdown
/send_embed_help channel:<#123456789012345678>
```
30 changes: 15 additions & 15 deletions docs/cogs/gestion_cdi.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Module de Gestion des CDI, CDD, Freelance, Intérim etc...
# 📈 Module de Gestion des CDI, CDD, Freelance, Intérim, etc.

Ce module, intégré au bot Discord Zone01, est responsable de la gestion des offres d'emploi en CDI. Il utilise une API générale regroupement de multiples applications de recrutement comme Linkedin, Indeed, HelloWork etc... pour récupérer les dernières offres et les publier dans un canal spécifique.
Découvrez le module de gestion des offres d'emploi pour le **Bot Discord Zone01** ! Ce module est responsable de la gestion des offres en CDI, CDD, Freelance, Intérim, et autres types de contrats. Il utilise une API générale intégrant plusieurs applications de recrutement telles que LinkedIn, Indeed, HelloWork, etc. pour récupérer les dernières offres et les publier dans un canal spécifique. 🌐

## Fonctionnalités
## 🌟 Fonctionnalités

### Commande `!update_cdi`
- **Description** : Cette commande force la mise à jour des offres d'emploi en CDI, CDD, Freelance, Intérim, etc.
- **Utilisation** : Lorsqu'un utilisateur exécute cette commande, un message de chargement est envoyé pour indiquer que la mise à jour est en cours. Le bot récupère alors les offres d'emploi depuis LinkedIn, Indeed LinkedIn, Indeed et autres APIs et les publie dans un canal de forum dédié.
- **Description :** Force la mise à jour des offres d'emploi en CDI, CDD, Freelance, Intérim, et autres. 📈
- **Utilisation :** Lorsqu'un utilisateur exécute cette commande, un message de chargement est envoyé pour indiquer que la mise à jour est en cours. Le bot récupère les offres d'emploi depuis LinkedIn, Indeed, et autres APIs, puis les publie dans un canal de forum dédié. 📢

### Processus de Mise à Jour
1. **Récupération des Offres** : Le bot utilise les fonctions `fetch_api_fulltime` pour obtenir les offres d'emploi.
2. **Création de Threads** : Pour chaque offre valide (titre, entreprise, lien), le bot crée un nouveau thread dans le canal de forum spécifié. Si un thread avec le même titre existe déjà, il passe à l'offre suivante pour éviter les doublons.
3. **Gestion des Erreurs** : Si l'une des APIs échoue, le bot informe l'utilisateur via un message d'erreur approprié.
### 🔄 Processus de Mise à Jour
1. **Récupération des Offres :** Le bot utilise les fonctions `fetch_api_fulltime` pour obtenir les offres d'emploi. 📊
2. **Création de Threads :** Pour chaque offre valide (titre, entreprise, lien), le bot crée un nouveau thread dans le canal de forum spécifié. Si un thread avec le même titre existe déjà, il passe à l'offre suivante pour éviter les doublons. 📎
3. **Gestion des Erreurs :** Si l'une des APIs échoue, le bot informe l'utilisateur via un message d'erreur approprié. 🚨

### Autres Détails
- **Canaux et Rôles** : Le module utilise des identifiants de canal et de rôle définis dans un fichier de configuration, facilitant la gestion des alertes pour les utilisateurs concernés.
- **Latence et Débogage** : Des vérifications de latence sont intégrées, et le bot gère les erreurs liées aux appels API et à la création de threads.
### 🔍 Autres Détails
- **Canaux et Rôles :** Le module utilise des identifiants de canal et de rôle définis dans un fichier de configuration, facilitant la gestion des alertes pour les utilisateurs concernés. 🛠️
- **Latence et Débogage :** Des vérifications de latence sont intégrées, et le bot gère les erreurs liées aux appels API et à la création de threads. 🕵️‍♂️

### Installation
Pour activer ce module, utilisez la commande `!update_cdi` et suivez les instructions fournies par le bot.
### 🚀 Installation
Pour activer ce module, utilisez la commande `!update_cdi` et suivez les instructions fournies par le bot. 📜

Ce module contribue à rendre l'accès aux offres d'emploi plus accessible pour les apprenants, en centralisant les informations pertinentes dans un seul endroit sur Discord.
Ce module contribue à rendre l'accès aux offres d'emploi plus accessible pour les apprenants, en centralisant les informations pertinentes dans un seul endroit sur Discord. 🌟
35 changes: 18 additions & 17 deletions docs/cogs/gestion_help.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
# 🛠️ Module de Gestion de la Commande `!help`

# Module de Gestion de la commande `!help`
Découvrez le module de gestion de la commande `!help` pour le **Bot Discord Zone01** ! Ce module permet aux utilisateurs d'obtenir une liste des commandes disponibles ainsi que des descriptions détaillées de chacune d'entre elles. 📜

Ce module, intégré au bot Discord Zone01, est responsable de la gestion de la commande `!help`. Cette commande permet aux utilisateurs d'obtenir une liste des commandes disponibles ainsi que des descriptions détaillées de chacune d'entre elles.

## Fonctionnalités
## 🌟 Fonctionnalités

### Commande `!help`
- **Description** : Affiche une liste de toutes les commandes disponibles avec une brève description de chacune.
- **Utilisation** : `!help` ou `!help [commande]`
- **Paramètres** :
- `[commande]` (optionnel) : Si spécifié, affiche des informations détaillées sur la commande donnée.
- **Description :** Affiche une liste de toutes les commandes disponibles avec une brève description de chacune. 📋
- **Utilisation :** `!help` ou `!help [commande]`
- **Paramètres :**
- `[commande]` (optionnel) : Si spécifié, affiche des informations détaillées sur la commande donnée. 🔍

### 🧩 Exemple d'Utilisation
- **Commande :** `!help`
- **Résultat :** Une liste de toutes les commandes disponibles est affichée avec leurs descriptions. 📝

### Exemple d'Utilisation
- **Commande** : `!help`
- **Résultat** : Une liste de toutes les commandes disponibles est affichée avec leurs descriptions.
### ⚙️ Exemple d'Utilisation Avancée
- **Commande :** `!help update_jobs`
- **Résultat :** Affiche des informations détaillées sur la commande `update_jobs`, y compris les paramètres et exemples d'utilisation. 📚

### Exemple d'Utilisation Avancée
- **Commande** : `!help update_jobs`
- **Résultat** : Affiche des informations détaillées sur la commande `update_jobs`, y compris les paramètres et exemples d'utilisation.
### 📝 Notes
- La commande `!help` est accessible à tous les utilisateurs du serveur. 🔓
- L'ajout de nouvelles commandes au bot met automatiquement à jour le module `!help` pour inclure les nouvelles fonctionnalités. 🔄

### Notes
- La commande `!help` est accessible à tous les utilisateurs du serveur.
- L'ajout de nouvelles commandes au bot met automatiquement à jour le module `!help` pour inclure les nouvelles fonctionnalités.
Utilisez ce module pour explorer toutes les commandes disponibles et découvrir comment tirer le meilleur parti de votre bot Discord Zone01 ! 🚀
30 changes: 15 additions & 15 deletions docs/cogs/gestion_jobs.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Module de Gestion des Alternances
# 🌟 Module de Gestion des Alternances

Ce module, intégré au bot Discord Zone01, est responsable de la gestion des offres d'emploi en alternance. Il utilise une API générale regroupement de multiples applications de recrutement comme Linkedin, Indeed, HelloWork etc... pour récupérer les dernières offres et les publier dans un canal spécifique.
Bienvenue dans le module de gestion des alternances pour le **Bot Discord Zone01** ! Ce module est dédié à la gestion des offres d'emploi en alternance et facilite leur publication dans un canal spécifique. 🚀

## Fonctionnalités
## 🚀 Fonctionnalités

### Commande `!update_jobs`
- **Description** : Cette commande force la mise à jour des offres d'emploi en alternances uniquement.
- **Utilisation** : Lorsqu'un utilisateur exécute cette commande, un message de chargement est envoyé pour indiquer que la mise à jour est en cours. Le bot récupère alors les offres d'emploi depuis LinkedIn, Indeed et autres APIs et les publie dans un canal de forum dédié.
- **Description :** Cette commande force la mise à jour des offres d'emploi en alternance uniquement. 📈
- **Utilisation :** Lorsqu'un utilisateur exécute cette commande, un message de chargement est envoyé pour indiquer que la mise à jour est en cours. Le bot récupère alors les offres d'emploi depuis LinkedIn, Indeed, HelloWork, et autres APIs, puis les publie dans un canal de forum dédié. 🛠️

### Processus de Mise à Jour
1. **Récupération des Offres** : Le bot utilise les fonctions `fetch_api_intern` pour obtenir les offres d'emploi.
2. **Création de Threads** : Pour chaque offre valide (titre, entreprise, lien), le bot crée un nouveau thread dans le canal de forum spécifié. Si un thread avec le même titre existe déjà, il passe à l'offre suivante pour éviter les doublons.
3. **Gestion des Erreurs** : Si l'une des APIs échoue, le bot informe l'utilisateur via un message d'erreur approprié.
### 🔄 Processus de Mise à Jour
1. **Récupération des Offres :** Le bot utilise la fonction `fetch_api_intern` pour obtenir les dernières offres d'emploi. 🌐
2. **Création de Threads :** Pour chaque offre valide (titre, entreprise, lien), le bot crée un nouveau thread dans le canal de forum spécifié. Si un thread avec le même titre existe déjà, le bot passe à l'offre suivante pour éviter les doublons. 🗂️
3. **Gestion des Erreurs :** Si l'une des APIs échoue, le bot informe l'utilisateur via un message d'erreur approprié. ⚠️

### Autres Détails
- **Canaux et Rôles** : Le module utilise des identifiants de canal et de rôle définis dans un fichier de configuration, facilitant la gestion des alertes pour les utilisateurs concernés.
- **Latence et Débogage** : Des vérifications de latence sont intégrées, et le bot gère les erreurs liées aux appels API et à la création de threads.
### 🔧 Autres Détails
- **Canaux et Rôles :** Le module utilise des identifiants de canal et de rôle définis dans un fichier de configuration, facilitant la gestion des alertes pour les utilisateurs concernés. 🎯
- **Latence et Débogage :** Des vérifications de latence sont intégrées, et le bot gère les erreurs liées aux appels API et à la création de threads. 🕵️‍♂️

### Installation
Pour activer ce module, utilisez la commande `!update_jobs` et suivez les instructions fournies par le bot.
### 📥 Installation
Pour activer ce module, utilisez la commande `!update_jobs` et suivez les instructions fournies par le bot. Le bot se charge ensuite de publier les nouvelles offres dans le canal spécifié. 💡

Ce module contribue à rendre l'accès aux offres d'emploi plus accessible pour les apprenants, en centralisant les informations pertinentes dans un seul endroit sur Discord.
Ce module contribue à rendre l'accès aux offres d'emploi plus accessible pour les apprenants, en centralisant les informations pertinentes dans un seul endroit sur Discord. 🌟
28 changes: 16 additions & 12 deletions docs/cogs/gestion_ping.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# Module de Gestion de la Latence `!ping`
# 📊 Module de Gestion de la Latence `!ping`

Ce module, intégré au bot Discord Zone01, est responsable de la gestion de la commande `!ping`. Cette commande permet aux utilisateurs de vérifier la latence du bot et d'obtenir des informations sur la connectivité du serveur.
Bienvenue dans le module de gestion de la latence pour le **Bot Discord Zone01** ! Ce module est responsable de la commande `!ping`, qui permet aux utilisateurs de vérifier la latence du bot et d'obtenir des informations sur la connectivité du serveur. 🌐

## Fonctionnalités
## 🚀 Fonctionnalités

### Commande `!ping`
- **Description** : Affiche la latence actuelle du bot, c'est-à-dire le temps nécessaire pour qu'un message envoyé par le bot soit reçu et renvoyé par Discord.
- **Utilisation** : `!ping`
- **Paramètres** : Aucun.
- **Description :** Affiche la latence actuelle du bot, c'est-à-dire le temps nécessaire pour qu'un message envoyé par le bot soit reçu et renvoyé par Discord. 🕒
- **Utilisation :** `!ping`
- **Paramètres :** Aucun.

### Exemple d'Utilisation
- **Commande** : `!ping`
- **Résultat** : Affiche la latence du bot en millisecondes (ms) et un message de confirmation.
### 💡 Exemple d'Utilisation
- **Commande :** `!ping`
- **Résultat :** Affiche la latence du bot en millisecondes (ms) et un message de confirmation. Par exemple : `Pong! Latency is 123ms`.

### Notes
- La commande `!ping` est utile pour diagnostiquer des problèmes de connexion et vérifier la réactivité du bot.
- Aucun paramètre n'est requis pour cette commande, elle fournit une réponse immédiate.
### 📝 Notes
- La commande `!ping` est utile pour diagnostiquer des problèmes de connexion et vérifier la réactivité du bot. 🔧
- Aucun paramètre n'est requis pour cette commande, elle fournit une réponse immédiate et simple. 📈

---

**Remarque :** La commande `!ping` est essentielle pour maintenir la performance et la réactivité du bot, et pour s'assurer que tout fonctionne comme prévu. Assurez-vous d'utiliser cette commande en cas de besoin pour surveiller la latence et optimiser l'expérience des utilisateurs. 🚀
Loading

0 comments on commit e2bea76

Please sign in to comment.