Documentation sur Discord (#8)

* docs: add base documentation about discord * fix: rewrite discord part * fix: build * fix: remove disclaimer about grammar & spell check Co-authored-by: Christophe Bernard <[email protected]>
Section-IG · Mar 23, 2022 · 4e6fcec · 4e6fcec
1 parent 0360da4
commit 4e6fcec
Show file tree

Hide file tree

Showing 72 changed files with 3,314 additions and 2,020 deletions.
diff --git a/docs/discord/_category_.json b/docs/discord/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Discord",
+  "position": 3
+}
diff --git a/docs/discord/bases/_category_.json b/docs/discord/bases/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Les bases",
+  "position": 2
+}
diff --git a/docs/discord/bases/les-messages-privés.mdx b/docs/discord/bases/les-messages-privés.mdx
@@ -0,0 +1,25 @@
+---
+sidebar_position: 3
+title: Les messages privés
+---
+
+import Image from '../../../src/components/Image';
+
+Sur Discord, tu peux entrer en contact avec d'autres personnes à travers des serveurs, mais aussi en leur envoyant un message privé.
+Ce type de message est appelé "Direct Messages" (DM) en anglais (nous ne ferons pas l'affront de le traduire).
+
+## Recevoir un DM
+
+Quand tu reçois un message privé, l'image de la personne qui te contacte s'affiche en haut à gauche de ton interface, au dessus de ta liste de serveurs.
+
+<Image src='/img/discord/direct-message.png' alt='Direct message' />
+
+## Répondre à un DM
+
+Pour répondre à ce genre de communication, il te faut simplement cliquer sur l'icône de la personne. Tu seras alors "transporté" dans un canal de discussion privé.
+Ce canal n'est accessible que par toi et la personne qui t'a contactée.
+
+## Messages privés de groupe
+
+Tu peux également recevoir ou créer des DMs à destination d'un groupe de personnes. Cela fonctionne de la même manière qu'un DM normal,
+mis à part le fait que tu n'as donc plus un groupe privé entre 2 personnes, mais bien avec plusieurs autres intervenants.
diff --git a/docs/discord/bases/les-serveurs.mdx b/docs/discord/bases/les-serveurs.mdx
@@ -0,0 +1,113 @@
+---
+sidebar_position: 2
+title: Les serveurs
+---
+
+import Image from '../../../src/components/Image';
+import RocketList from '../../../src/components/RocketList';
+
+Une fois un serveur rejoint, la vraie aventure commence. En effet, plein de nouveautés font leur apparition. Démarrons sans plus tarder.
+
+## Qu'est-ce qu'un serveur?
+
+Un serveur, aussi appelé "guilde", est un ensemble de canaux écrits et vocaux qui permettent de mettre en relation un groupe de personnes (les membres du serveur).
+Sur Discord, un serveur est représenté par une icône ronde sur le côté gauche de la fenêtre.
+
+Pour expliquer ce point plus en détails, nous proposons de prendre le serveur de la section IG pour exemple.
+
+## Message privé d'IESN Bot
+
+À l'arrivée sur le serveur, tu reçois normalement un message privé de la part d'un certain **IG Bot**. C'est automatique.
+Lis bien le message qu'il t'envoie, il regorge en général d'informations importantes pour la prise en main du serveur que tu viens à peine de rejoindre!
+
+## Ce que l'on voit, la première fois
+
+Quand tu arrives sur un nouveau serveur, tu es bien souvent perdu. C'est normal, tout le monde n'a pas la même manière de structurer son serveur.
+Pas de soucis, on va rapidement faire le tour!
+
+Voici ce que tu vois sur **Section IG** quand tu n'as pas de rôle spécial :
+
+<Image
+    src='/img/discord/channels-no_role.png'
+    alt='Channels seen with no role'
+/>
+
+Les canaux les plus importants sont les suivants :
+
+<RocketList>
+    <li>
+        <strong>📜informations</strong> : contient le règlement et les
+        informations générales du serveur
+    </li>
+    <li>
+        <strong>📖faq</strong> : contient une suite de questions-réponses
+        concernant le serveur
+    </li>
+    <li>
+        <strong>🔎roles</strong> : contient un message qui gère automatiquement
+        l'attribution des rôles (il suffit simplement de cliquer sur l'emoji de
+        ton choix
+    </li>
+    <li>
+        <strong>📣annonces</strong> : contient toutes les annonces faites par
+        les membres du personnel en charge du serveur et à destination de tous
+        les membres de ce dernier
+    </li>
+</RocketList>
+
+## L'étudiant et le prof
+
+### La partie commune
+
+Que tu sois un prof ou un étudiant, tu verras la catégorie "Common Profs-Étudiants". Le contenu reste sensiblement le même, à 2 exceptions près! Les canaux suivants ne sont visibles que par les étudiants :
+
+<RocketList>
+    <li>
+        <strong>📝réclamations_délégués</strong> : un canal informatique qui met
+        à disposition un formulaire de plaintes à destination des délégués
+    </li>
+    <li>
+        <strong>💬common-étudiants</strong> : un canal où les étudiants (tous
+        blocs confondus) peuvent échanger librement
+    </li>
+</RocketList>
+
+### Le reste
+
+Voici ce qu'il s'affiche une fois un rôle attribué :
+
+| Étudiant                                                           | Professeur                                                     |
+| ------------------------------------------------------------------ | -------------------------------------------------------------- |
+| <Image src='/img/discord/student.png' alt="La vue d'un étudiant"/> | <Image src='/img/discord/teacher.png' alt="La vue d'un prof"/> |
+
+Et voilà à quoi ressemble une catégorie associée à un _bloc étudiant_.
+
+<Image src='/img/discord/bloc.png' alt='Un bloc étudiant' />
+
+Tous les blocs sont basés sur un même modèle :
+
+<RocketList>
+    <li>
+        <strong>💬discussion-bX</strong> : un canal écrit accessible uniquement
+        par les étudiants
+    </li>
+    <li>
+        <strong>💬salle-de-classe</strong> : un canal écrit pour les cours à
+        distance
+    </li>
+    <li>
+        <strong>🔊 Salon public</strong> : un canal vocal dynamique. Cela
+        signifie qu'une fois rejoint, il génère un nouveau canal, pour les cours
+        ou les discussions entre étudiants. Ce canal généré est supprimé
+        lorsqu'il est vide.
+    </li>
+</RocketList>
+
+Tous les autres canaux sont donc uniques à chaque bloc (tu ne trouveras pas deux canaux **#oed**, en somme).
+
+:::note
+Les étudiants d'un bloc n'ont accès qu'aux canaux de leur bloc alors que les professeurs voient directement tous les blocs et ont accès à tous les **canaux de cours** de ceux-ci!
+Voici ce que voit un prof en ouvrant la catégorie "Bloc 1" :
+
+<Image src='/img/discord/bloc-prof.png' alt="Vue d'un bloc par un prof" />
+:::
diff --git a/docs/discord/bases/se-connecter-et-déconnecter.mdx b/docs/discord/bases/se-connecter-et-déconnecter.mdx
@@ -0,0 +1,35 @@
+---
+sidebar_position: 1
+title: Se connecter et se déconnecter
+---
+
+import Img from '../../../src/components/Image';
+
+Pas mal de gens se retrouvent avec plusieurs comptes Discord parce qu'ils ne comprennent pas comment se reconnecter sur le compte qu'ils ont utilisé le jour précédent. Alors, aujourd'hui, nous avons décidé de t'expliquer rapidement comment faire!
+
+## Se créer un compte
+
+Il va de soi que pour se connecter à son compte, il faut bien évidemment s'en créer un. Rends-toi sur https://discord.com et clique sur "Ouvrir Discord dans ton navigateur".
+
+<Img src='/img/discord/signup.png' alt='Sign Up' />
+
+Il te sera ensuite demandé d'introduire **ton pseudo** et d'**accepter les Conditions d'Utilisation et la Politique de Confidentialité** de l'application. Une fois cela réalisé, tu seras redirigé dans l'application où il te sera proposé de créer un serveur. Passe cette étape, elle ne nous intéresse pas actuellement!
+Le plus important, c'est d'**enregistrer ton compte** en spécifiant un email et un mot de passe. Ainsi, tu pourras te reconnecter à foison!
+
+## Se connecter
+
+Pour se connecter, je conseille toujours d'utiliser le bouton "Se connecter" qui se trouve en haut à droite sur le site web. Cela évite de recréer un compte par inadvertance!
+
+<Img src='/img/discord/login.png' alt='Log In' />
+
+Il te suffit ainsi d'entrer ton **adresse email et ton mot de passe** pour te connecter. Si tu as activé l'authentification à 2 étapes, il te sera également demandé soit d'entrer un code à 6 chiffres donné par l'application mobile que tu as installée, soit d'aller ouvrir tes mails et de cliquer sur le lien que Discord t'a communiqué. Des étapes vues et revues, en somme!
+
+## Se déconnecter
+
+Pour se déconnecter, rien de plus simple! Ouvre tes paramètres...
+
+<Img src='/img/discord/settings.png' alt='Settings' />
+
+et appuye sur le texte rouge "Déconnexion". Une petite pop-up s'ouvrira et te demandera ainsi de confirmer ton choix.
+
+<Img src='/img/discord/logout.png' alt='Logout' />
diff --git a/docs/discord/intro.mdx b/docs/discord/intro.mdx
@@ -0,0 +1,36 @@
+---
+sidebar_position: 1
+title: Introduction
+---
+
+import Grid from '../../src/components/Grid';
+import DiscordCard from '../../src/components/DiscordCard';
+import Image from '../../src/components/Image';
+
+Discord est un moyen de communication important au sein de la section Informatique de Gestion, et nous osons l'imaginer également dans d'autres groupes étudiants.
+
+Bien qu'actuellement non-officiel, le serveur de la section IG est peuplé d'étudiants de tous les blocs, mais également de professeurs et d'alumni (les anciens).
+
+## L'intérêt de cette catégorie
+
+Tu retrouveras plus loin dans ces articles de nombreuses anecdotes, conseils et informations qui, nous espérons, t'aideront à mieux comprendre l'outil.
+
+Cependant, si tu souhaites avoir des informations plus précises, nous te conseillons de te rendre sur ces différents sites:
+
+-   [Discordia](https://discordia.me), un wiki pour Discord
+-   [Discord Developer Portal](https://discord.com/developers), le portail développeur officiel de Discord
+-   [Discord Blog](https://blog.discord.com), le blog officiel de Discord
+-   [Discord Support](https://support.discord.com/hc/fr), le centre d'aide officiel de Discord
+
+## Étudiant·e à l'IESN?
+
+Tu es un·e étudiant·e à l'IESN et l'une des sections ci-dessous te semble familière ?
+Rejoins tes pairs, réclame ton rôle et fais-toi une place au sein de la communauté!
+
+<Grid>
+    <DiscordCard
+        inviteCode='N8k7sgBdnn'
+        title='Serveur créé en Septembre 2017'
+    />
+    <DiscordCard inviteCode='TtqWDvp' title='Serveur créé en Mars 2020' />
+</Grid>
diff --git a/docs/discord/messages/_category_.json b/docs/discord/messages/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Les messages",
+  "position": 3
+}
diff --git a/docs/discord/messages/faire-des-annonces-et-autre.mdx b/docs/discord/messages/faire-des-annonces-et-autre.mdx
@@ -0,0 +1,83 @@
+---
+sidebar_position: 2
+title: Les mentions dans Discord
+---
+
+import Image from '../../../src/components/Image';
+import {
+    DiscordMessage,
+    DiscordMessages,
+    DiscordMention
+} from '@skyra/discord-components-react';
+
+Outre son incroyable capacité de formatage de texte empruntée à Markdown, l'une des caractéristiques très utile avec Discord, c'est que tu peux créer un hyper-lien vers pratiquement n'importe quoi.
+Étroitement liée avec la page de documentation sur les [identifiants](/docs/discord/plus-loin/les-identifiants), la lecture de ce chapitre te permettra de comprendre comment fonctionne une petite partie de l'application.
+
+## Les canaux
+
+Imagine que tu veux rediriger quelqu'un vers un canal spécifique mais que le serveur où tu te trouves comporte un énorme nombre de canaux.
+Pas facile de retrouver le canal sur base d'un simple nom. Discord a mis en place un système d'hyper-lien qui te permet, quand tu notes un message, de transformer le nom d'un canal en un hyper-lien.
+
+Rien de plus simple : il suffit d'écrire `#` suivi du nom du canal. Tu peux même choisir un canal parmi ceux proposés dans la liste.
+
+<DiscordMessages>
+    <DiscordMessage
+        author='HunteRoi'
+        avatar='https://media.discordapp.net/attachments/622823610905657375/955445785871392828/5407f1edadb857875b233270a1567ee3.png'
+    >
+        <DiscordMention type='channel'>informations</DiscordMention>
+    </DiscordMessage>
+</DiscordMessages>
+
+[Voir en GIF](/img/discord/channel-mention.gif)
+
+## Les utilisateurs et les rôles
+
+Pour créer un hyper-lien vers un utilisateur ou même un rôle, c'est une syntaxe identique qui est en place : un `@` suivi du nom de l'utilisateur/du rôle.
+
+<DiscordMessages>
+    <DiscordMessage
+        author='HunteRoi'
+        avatar='https://media.discordapp.net/attachments/622823610905657375/955445785871392828/5407f1edadb857875b233270a1567ee3.png'
+        highlight
+    >
+        <DiscordMention type='user'>HunteRoi</DiscordMention> (utilisateur)
+    </DiscordMessage>
+    <DiscordMessage
+        author='HunteRoi'
+        avatar='https://media.discordapp.net/attachments/622823610905657375/955445785871392828/5407f1edadb857875b233270a1567ee3.png'
+    >
+        <DiscordMention type='user'>EverKill</DiscordMention> (utilisateur)
+    </DiscordMessage>
+    <DiscordMessage
+        author='HunteRoi'
+        avatar='https://media.discordapp.net/attachments/622823610905657375/955445785871392828/5407f1edadb857875b233270a1567ee3.png'
+    >
+        <DiscordMention type='role'>Modérateur</DiscordMention> (rôle)
+    </DiscordMessage>
+</DiscordMessages>
+
+[Voir en GIF (user)](/img/discord/user-mention.gif) • [Voir en GIF (role)](/img/discord/role-mention.gif)
+
+:::warning Attention!
+Un hyper-lien vers un utilisateur ou un rôle se nomme "une mention" et envoie une notification à la ou aux personnes concernées. Utilise cela avec parcimonie!
+:::
+
+Discord possède également 2 rôles spéciaux : "here" et "everyone". Le premier permet de mentionner _tous les utilisateurs **en ligne**_ et ayant accès au canal écrit dans lequel tu l'envoies. Le second permet de mentionner _tous les utilisateurs_ qui ont accès au canal écrit.
+
+<DiscordMessages>
+    <DiscordMessage
+        author='HunteRoi'
+        avatar='https://media.discordapp.net/attachments/622823610905657375/955445785871392828/5407f1edadb857875b233270a1567ee3.png'
+        highlight
+    >
+        <DiscordMention type='user'>everyone</DiscordMention> (rôle spécial)
+    </DiscordMessage>
+    <DiscordMessage
+        author='HunteRoi'
+        avatar='https://media.discordapp.net/attachments/622823610905657375/955445785871392828/5407f1edadb857875b233270a1567ee3.png'
+        highlight
+    >
+        <DiscordMention type='role'>here</DiscordMention> (rôle spécial)
+    </DiscordMessage>
+</DiscordMessages>
diff --git a/docs/discord/messages/go-live.mdx b/docs/discord/messages/go-live.mdx
@@ -0,0 +1,28 @@
+---
+sidebar_position: 3
+title: Streamer son écran
+---
+
+import RocketList from '../../../src/components/RocketList';
+import FlagEmoji from '../../../src/components/FlagEmoji';
+
+Discord a créé sa fonctionnalité "Go Live" (littéralement "Passer en direct") et a commencé à progressivement la mettre à disposition de ses utilisateurs en août 2019. Cette fonctionnalité est à présent bien ancrée dans l'application, et attire évidemment beaucoup de monde.
+
+En effet, la version "Go Live" étend son parent "Go Live - ScreenShare" (qui permettait déjà de partager son écran ou sa webcam en messages privés) en autorisant les utilisateurs à partager leur écran, une application spécifique ou un jeu vidéo _depuis un serveur_!
+
+Nous te proposons de consulter directement le tutoriel réalisé par Discord pour "Go Live" !
+
+<RocketList>
+    <li>
+        <a href='https://support.discordapp.com/hc/fr/articles/360040816151-Share-your-screen-with-Go-Live-Screen-Share'>
+            Go Live FAQ
+        </a>
+        <FlagEmoji name='discord/flag_gb.svg' />
+    </li>
+    <li>
+        <a href='https://support.discordapp.com/hc/fr/articles/360030714312-Go-Live-FAQ'>
+            Go Live FAQ
+        </a>
+        <FlagEmoji name='discord/flag_fr.svg' />
+    </li>
+</RocketList>