Skip to content

Commit

Permalink
update developing section
Browse files Browse the repository at this point in the history
adding english content to the french version and hiding remote framework specific details
  • Loading branch information
antocg committed Jan 10, 2023
1 parent 81b4b7b commit 46fb2a8
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 33 deletions.
32 changes: 18 additions & 14 deletions 04-developper-fr.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,28 @@ Veuillez lire attentivement ce guide avant de commencer et vous y référer rég

Nous avons établi ici une liste de priorités pour les personnes qui souhaitent contribuer aux ateliers `R`. L'idéal serait que les équipes de développement accomplissent toutes ces tâches, mais si les circonstances rendent cela impossible, il est important de se concentrer sur les changements structurels avant les questions de style.

**Spécifique à l'adaptation des ateliers au cadre à distance:**

1. Les ateliers doivent s'adapter à un nouveau format de 3 heures (comprenant des exercices et une ou deux pauses de cinq minutes). Pour cela, vous pouvez cacher les diapositives des ateliers existants pour les adapter à ce format. Par exemple, vous pouvez masquer les exemples répétitifs, les diapositives non essentielles ou certaines des diapositives avancées supplémentaires qui sont incluses à la fin des ateliers. Nous sommes conscients que certains ateliers seront plus difficiles à raccourcir que d'autres; ce n'est pas un problème que les ateliers durent un peu plus de 3 heures pour garantir des informations précises et complètes. (*Utilisez votre jugement*).

2. **Ne supprimez pas les diapositives**. Pour cacher une diapositive pour l'instruction à distance, utilisez la balise `exclude: true`. Voir un exemple ci-dessous :

```
---
exclude: true
>Une version de cette liste sous forme de liste de contrôle a été ouverte en tant que besoin dans le dépôt [GitHub](https://github.com/QCBSRworkshops) pour chaque atelier respectif. Nous vous suggérons d'utiliser ces listes de contrôle comme un moyen de suivre votre progression tout en travaillant et en vous coordonnant avec votre collègue développeur, le cas échéant. Elles peuvent également être utilisées comme référence pour rapporter le travail accompli aux coordinateurs de la série d'ateliers R du CSBQ, ou pour demander des heures supplémentaires.
```{r, echo=FALSE}
# **Spécifique à l'adaptation des ateliers au cadre à distance:**
#
# 1. Les ateliers doivent s'adapter à un nouveau format de 3 heures (comprenant des exercices et une ou deux pauses de cinq minutes). Pour cela, vous pouvez cacher les diapositives des ateliers existants pour les adapter à ce format. Par exemple, vous pouvez masquer les exemples répétitifs, les diapositives non essentielles ou certaines des diapositives avancées supplémentaires qui sont incluses à la fin des ateliers. Nous sommes conscients que certains ateliers seront plus difficiles à raccourcir que d'autres; ce n'est pas un problème que les ateliers durent un peu plus de 3 heures pour garantir des informations précises et complètes. (*Utilisez votre jugement*).
#
# 2. **Ne supprimez pas les diapositives**. Pour cacher une diapositive pour l'instruction à distance, utilisez la balise `exclude: true`. Voir un exemple ci-dessous :
#
#```
#---
#exclude: true
#
# Titre de la diapositive : J'adore les statistiques !
#
### Contenu : Incroyable !
---
#---
#```
#
# 3. Développez de nouveaux exercices ou adaptez les exercices actuels pour mieux répondre au format d'atelier à distance et à l'utilisation des salles de discussion. Les exercices doivent être informatifs et attrayants. N'oubliez pas de prévoir et de laisser le temps nécessaire pour travailler sur les exercices et de poser des questions.
```

3. Développez de nouveaux exercices ou adaptez les exercices actuels pour mieux répondre au format d'atelier à distance et à l'utilisation des salles de discussion. Les exercices doivent être informatifs et attrayants. N'oubliez pas de prévoir et de laisser le temps nécessaire pour travailler sur les exercices et de poser des questions.

**Priorités générales:**

1. Traiter les problèmes existants soumis à GitHub, qui sont notés dans la section "Issues" du dépot GitHub.
Expand Down
40 changes: 21 additions & 19 deletions 09-developing-en.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,28 @@ Please read through this guide **carefully** before starting, and refer back to

Here we have compiled a list of priorities for workshop developers. Ideally, all of these tasks would be accomplished in the alloted timeframe. However, if circumstances make this impossible, it is important to focus on structural changes before issues of style. Please note that these tasks are to be shared amongst developers for each workshop.

>A checklist version of this list has now been opened as an issue within the [GitHub](https://github.com/QCBSRworkshops) repository for each respective workshop. We suggest using these checklists as a way of tracking your progress while working and coordinating with your fellow developer. It can also be used as a reference for reporting the work completed to the QCBS R Workshop coordinators, or requesting additional hours.
**Specific to adapting workshops to remote framework:**

1. Workshops should fit a new 3-hour format (including exercises and one or two breaks of five minutes). For this, you may choose to hide slides from existing workshops to fit this format. For instance, you may hide repetitive examples, non-essential slides or some of the additional advanced slides that are included at the end of the workshops. We are aware that some workshops will be more difficult to shorten than others; it is not a problem that workshops run slightly over 3 hours to guarantee accurate and complete information. (*Use your judgment*).

2. **DO NOT** delete slides. To hide a slide for remote instruction, use the `exclude: true` tag. See an example below:

>A checklist version of this list has now been opened as an issue within the [GitHub](https://github.com/QCBSRworkshops) repository for each respective workshop. We suggest using these checklists as a way of tracking your progress while working and coordinating with your fellow developer, if applicable. It can also be used as a reference for reporting the work completed to the QCBS R Workshop Series coordinators, or requesting additional hours.
```{r, echo=FALSE}
# **Specific to adapting workshops to remote framework:**
#
# 1. Workshops should fit a new 3-hour format (including exercises and one or two breaks of five minutes). For this, you may choose to hide slides from existing workshops to fit this format. For instance, you may hide repetitive examples, non-essential slides or some of the additional advanced slides that are included at the end of the workshops. We are aware that some workshops will be more difficult to shorten than others; it is not a problem that workshops run slightly over 3 hours to guarantee accurate and complete information. (*Use your judgment*).
#
# 2. **DO NOT** delete slides. To hide a slide for remote instruction, use the `exclude: true` tag. See an example below:
#
#```
# ---
# exclude: true
#
# # Slide title: I love statistics!
#
# ### Content: Amazing!
# ---
#
#```
#
# 3. Develop new or adapt current exercises to better suit the remote workshop format and the use of breakout rooms. Exercises should be informative and engaging. Remember to leave time for students to work through exercises and ask questions.
```
---
exclude: true
# Slide title: I love statistics!
### Content: Amazing!
---
```

3. Develop new or adapt current exercises to better suit the remote workshop format and the use of breakout rooms. Exercises should be informative and engaging. Remember to leave time for students to work through exercises and ask questions.

**General priorities:**

Expand Down

0 comments on commit 46fb2a8

Please sign in to comment.