Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Important modifications to be applied to Workshop 4 #5

Open
21 tasks done
estebangongora opened this issue Nov 2, 2020 · 0 comments
Open
21 tasks done

Important modifications to be applied to Workshop 4 #5

estebangongora opened this issue Nov 2, 2020 · 0 comments
Assignees
Labels
bug Something isn't working enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@estebangongora
Copy link
Contributor

estebangongora commented Nov 2, 2020

Before developing and modifying this workshop, please read through the presenter and developer protocol carefully and refer back to it regularly as you work.

General issues to be addressed

Specific to adapting workshops to a remote framework:

  • Fit this workshop to a 3-hour format. The duration of this workshop should be ~3 hours (including exercises and one or two breaks of 5 minutes; excluding longer breaks). To fit this format, please add, edit, or hide slides from existing workshops. You can begin by hiding repetitive examples, non-essential slides, or some of the additional advanced slides that are included at the end of some workshops. Some workshops will be more difficult to shorten than others, due to their subject matter. It is not a problem to let these workshops run slightly over 3 hours to guarantee accurate and complete information. (Use your judgment). DO NOT delete slides. Use the instruction: hidden_remote tag. See an example below:
---
exclude: true

# Slide title: I love statistics!

### Content: Amazing!
---
  • 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. Refer to these guidelines to find suggestions of exercises promoting active learning. You may use additional resources to create the exercises.

Specific to slide structure, grammar and style

  • Ensure code is working correctly and that code matches workshop presentation. Continue to check this as you make changes.

  • Proofread correcting spelling, grammar, or punctuation errors.

  • Look for and correct the content of slides that overflow the screen (for example, slides 85 and 88).

  • Look for and correct prose that mentions function names, object names, package names and code chunks that do not use backticks.

  • Look for and correct unnecessary abbreviations (e.g. use do not instead of don’t).

  • Correct unnecessary long sentences.

  • Ensure that the slides are written in a consistent style, which helps with the flow of workshops and student understanding. This is especially important when working collaboratively with other developers.

  • Include presenter notes to the slides you modify. You can write notes for yourself to read in the presenter mode (press the keyboard shortcut p). These notes are written under three question marks ???. See the example below:

---
The content of this workshop is essential for your graduate studies.

???

Note: _The presenter should sing this slide to the participants_.
---

Specific to the translation of this workshop

  • Add and translate the modified content to the French version of the workshop.

  • Proofread and correct spelling, grammar and punctuation errors.

  • Correct unnecessary long sentences.

Specific to this workshop

Only close this issue after all cases have been ticked and verified.

@estebangongora estebangongora added the bug Something isn't working label Nov 2, 2020
@estebangongora estebangongora pinned this issue Nov 2, 2020
@pedrohbraga pedrohbraga added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Nov 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants