Skip to content

Commit

Permalink
fix guides GIFs, anchors and emojis
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancoisPgm committed Aug 2, 2021
1 parent 828afd1 commit a280962
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 36 deletions.
45 changes: 26 additions & 19 deletions content/en/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ We made a bunch of GIFs because GIFs are worth 5000 words. You can see them when

<details>

<summary> :stars: GIF - Click to <b>open</b> this useless GIF :arrow_down: </summary>
<img src="../../static/img/guide/useless_gif.webp" alt="useless GIF"/>
<summary> &#127776 GIF - Click to <b>open</b> this useless GIF &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/useless_gif.webp" alt="useless GIF"/>

</details>

Expand All @@ -37,6 +37,7 @@ We will first give some quick pointers to help you configure and use the tool in

Any question ? Ask us in the `#help-general` channel.

<a name="1-Configuring-your-account"></a>
### 1. Configuring your account

#### PROFILE
Expand All @@ -48,10 +49,11 @@ When you set up your profile there are two things to bear in mind:

<details>

<summary> :stars: GIF - To <b>edit</b> your profile :arrow_down: </summary>
<img src="../../static/img/guide/discord_update_profile.gif" alt="Edit yout profile"/>
<summary> &#127776 GIF - To <b>edit</b> your profile &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_update_profile.gif" alt="Edit yout profile"/>

</details>
<br/>

#### STATUS UPDATES

Expand All @@ -66,11 +68,13 @@ Your status is by default managed automatically by Discord, which will update it

<details>

<summary> :stars: GIF - To <b>update</b> your status :arrow_down: </summary>
<img src="../../static/img/guide/discord_update_status.gif" alt="Update your status"/>
<summary> &#127776 GIF - To <b>update</b> your status &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_update_status.gif" alt="Update your status"/>

</details>
<br/>

<a name="2-Channel-and-Notification-settings"></a>
### 2. Channel and Notification settings

#### How use and create channels
Expand All @@ -83,15 +87,16 @@ You can create new categories or channels for relevant topics (e.g. your project

<details>

<summary> :stars: GIF - To <b>create</b> a new channel :arrow_down: </summary>
<img src="../../static/img/guide/discord_create_channel.gif" alt="Create a new channel"/>
<summary> &#127776 GIF - To <b>create</b> a new channel &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_create_channel.gif" alt="Create a new channel"/>

</details>
<br/>

| :warning: A note on creating channels |
| A note on creating channels |
|:---------------------------|
| You are free to create as many channels as you would like. However, channels dedicated to projects should be made public (not private) so people can collaborate or help you. Also be careful not to create redundant channels. |

<br/>

#### Configure your notifications
Discord notifications are great, but they may bother you when you try to focus on your project. There are a lot of options for you to determine how and when you are informed about content – and at what level of granularity.
Expand All @@ -111,12 +116,13 @@ Discord notifications are great, but they may bother you when you try to focus o

<details>

<summary> :stars: GIF - To <b>change</b> notification settings :arrow_down: </summary>
<img src="../../static/img/guide/discord_notification_settings.gif" alt="Notification settings"/>
<summary> &#127776 GIF - To <b>change</b> notification settings &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_notification_settings.gif" alt="Notification settings"/>

</details>
<br/>


<a name="3-Communicating-with-others"></a>
### 3. Communicating with others

#### A FEW POINTS OF ETIQUETTE
Expand All @@ -127,10 +133,11 @@ Discord notifications are great, but they may bother you when you try to focus o

<details>

<summary> :stars: GIF - To <b>reply</b> to a message :arrow_down: </summary>
<img src="../../static/img/guide/discord_reply.gif" alt="Reply to message"/>
<summary> &#127776 GIF - To <b>reply</b> to a message &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_reply.gif" alt="Reply to message"/>

</details>
<br/>

##### Use @everyone, @here and other handles sparingly
* If you type **@everyone** or **@here** or other general handles (**@instructors**) in a message that will send a notification to everyone in that channel. Please use this only for items that really do need everyone’s attention.
Expand Down Expand Up @@ -159,11 +166,11 @@ That said, DM are useful to discuss privately with other people (one or many) an

<details>

<summary> :stars: GIF - To <b>make</b> direct message :arrow_down: </summary>
<img src="../../static/img/guide/discord_dm.gif" alt="Direct message"/>
<summary> &#127776 GIF - To <b>make</b> direct message &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_dm.gif" alt="Direct message"/>

</details>

<br/>

#### Sending files

Expand Down Expand Up @@ -191,7 +198,7 @@ You can find images for things like :brainhack:, etc.

Take a look at them and feel free to [add more custom emoji](https://support.discord.com/hc/en-us/articles/360036479811-Custom-Emojis) yourself.


<a name="4-BrainHack-School-Features"></a>
### 4. BrainHack School Features

We have set some useful features for you.
Expand Down
43 changes: 26 additions & 17 deletions content/fr/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Nous avons fait quelques GIFs car un GIF vaut 5000 mots. Vous pourrez les voir e

<details>

<summary> :stars: GIF - Cliquer pour <b>afficher</b> ce GIF inutile :arrow_down: </summary>
<img src="../../static/img/guide/useless_gif.webp" alt="GIF inutile"/>
<summary> &#127776 GIF - Cliquer pour <b>afficher</b> ce GIF inutile &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/useless_gif.webp" alt="GIF inutile"/>

</details>

Expand All @@ -36,6 +36,7 @@ Voici tout d'abord des raccourcis vers les principaux sujets de ce guide.

Une question ? Posez la dans le salon `#help-general`.

<a name="1-Configurez-votre-compte"></a>
### 1. Configurez votre compte

#### PROFIL
Expand All @@ -47,10 +48,11 @@ Lorsque vous configurez votre profil, il y a deux choses à garder en tête:

<details>

<summary> :stars: GIF - Pour <b>éditer</b> votre profil :arrow_down: </summary>
<img src="../../static/img/guide/discord_update_profile.gif" alt="Éditez votre profil"/>
<summary> &#127776 GIF - Pour <b>éditer</b> votre profil &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_update_profile.gif" alt="Éditez votre profil"/>

</details>
<br/>

#### STATUT

Expand All @@ -63,11 +65,13 @@ Vous pouvez supprimer un statut personnalisé à tout moment en cliquant sur vot

<details>

<summary> :stars: GIF - Pour <b>mettre à jour</b> votre statut :arrow_down: </summary>
<img src="../../static/img/guide/discord_update_status.gif" alt="Mettre à jour votre statut"/>
<summary> &#127776 GIF - Pour <b>mettre à jour</b> votre statut &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_update_status.gif" alt="Mettre à jour votre statut"/>

</details>
<br/>

<a name="2-Salons-et-notifications"></a>
### 2. Salons et notifications

#### Utiliser et créer des salons
Expand All @@ -80,14 +84,16 @@ Vous pouvez créer de nouvelles catégories ou de nouveaux salons pour des sujet

<details>

<summary> :stars: GIF - Pour <b>créer</b> un nouveau salon :arrow_down: </summary>
<img src="../../static/img/guide/discord_create_channel.gif" alt="Créer un nouveau salon"/>
<summary> &#127776 GIF - Pour <b>créer</b> un nouveau salon &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_create_channel.gif" alt="Créer un nouveau salon"/>

</details>
<br/>

| :warning: Note sur la création de salons |
| Note sur la création de salons |
|:---------------------------|
| Vous êtes libre de créer autant de salons que vous voulez. Ceci dit, les salons dédiés aux projets devraient être publiques afin que d'autres puissent facilement collaborer ou vous aider. Aussi faites attention à ne pas créer de salons redondants. |
<br/>


#### Configurer les notifications
Expand All @@ -108,12 +114,13 @@ Les notifications Discord sont super, mais elles peuvent devenir embêtantes lor

<details>

<summary> :stars: GIF - Pour <b>changer</b> les paramètres de notifications :arrow_down: </summary>
<img src="../../static/img/guide/discord_notification_settings.gif" alt="Paramètres de notifications"/>
<summary> &#127776 GIF - Pour <b>changer</b> les paramètres de notifications &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_notification_settings.gif" alt="Paramètres de notifications"/>

</details>
<br/>


<a name="3-Communiquer-avec-les-autres"></a>
### 3. Communiquer avec les autres

#### QUELQUES POINTS D'ÉTIQUETTE
Expand All @@ -124,10 +131,11 @@ Les notifications Discord sont super, mais elles peuvent devenir embêtantes lor

<details>

<summary> :stars: GIF - Pour <b>répondre</b> à un message :arrow_down: </summary>
<img src="../../static/img/guide/discord_reply.gif" alt="Répondre à un message"/>
<summary> &#127776 GIF - Pour <b>répondre</b> à un message &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_reply.gif" alt="Répondre à un message"/>

</details>
<br/>

##### Utiliser @everyone, @here et les autres mentions avec parcimonie
* Si vous tapez **@everyone** ou **@here** ou une autre mention (**@instructors**) dans un message, cela va envoyer une notification à tout le monde (ou les personnes concernées). Veuillez utiliser ces mentions uniquement pour les messages qui nécessitent effectivement l'attention de tous.
Expand Down Expand Up @@ -155,10 +163,11 @@ Ceci dit, les messages directs sont utiles pour discuter sans encombrer les salo

<details>

<summary> :stars: GIF - Pour <b>envoyer</b> un message direct :arrow_down: </summary>
<img src="../../static/img/guide/discord_dm.gif" alt="Direct message"/>
<summary> &#127776 GIF - Pour <b>envoyer</b> un message direct &#11015 </summary>
<img src="https://raw.githubusercontent.com/BrainhackMTL/psy6983_2021/master/static/img/guide/discord_dm.gif" alt="Direct message"/>

</details>
<br/>


#### Envoyer des fichiers
Expand Down Expand Up @@ -187,7 +196,7 @@ Vous trouverez des images comme :brainhack:, etc.

Vous êtes libre d'[ajouter plus d'emoji personnalisés](https://support.discord.com/hc/en-us/articles/360036479811-Custom-Emojis).


<a name="4-Particularités-BrainHack"></a>
### 4. Particularités BrainHack

Quelques spécificités relatives au serveur BrainHack.
Expand Down

0 comments on commit a280962

Please sign in to comment.