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

Ep 3: Add data files for lessons with Sam and Jamie #1261

Open
bielsnohr opened this issue Nov 9, 2021 · 5 comments
Open

Ep 3: Add data files for lessons with Sam and Jamie #1261

bielsnohr opened this issue Nov 9, 2021 · 5 comments
Labels
help wanted Looking for Contributors type:enhancement Propose enhancement to the lesson

Comments

@bielsnohr
Copy link

In the most two recent runs of this lesson at our institution, we got some feedback for the following exercises in episode 3:

  1. https://swcarpentry.github.io/shell-novice/03-create/index.html#more-on-wildcards
  2. https://swcarpentry.github.io/shell-novice/03-create/index.html#organizing-directories-and-files

Learners (and instructors) felt that it was difficult to follow these exercises because there aren't any files in the lesson data on which to experiment and demonstrate the correct commands.

I propose adding the relevant files to the lesson data for each of these lessons. If this doesn't clash with anything else, then I would be happy to hear ideas about where the data should be placed. Perhaps under folders named after the characters (Sam and Jamie) for each of these exercises? Also happy to get a PR together for this.

Thanks!

@deppen8
Copy link
Contributor

deppen8 commented Nov 10, 2021

Thanks for passing that feedback along, @bielsnohr. It is always helpful to hear how things work "in the wild".

@gcapes has been working on a major overhaul of the files (#1233), partly to address these kinds of issues. That said, I don't think he has planned any changes to the examples you cited.

A few possibilities as I see them; I'd welcome others' input.

  • Change nothing: I think one could argue that there is value in trying to solve the exercises without having the data at hand. It forces the learner to reason through it more explicitly.
  • Re-implement the exercises to work with existing datasets: This feels like the ideal solution, but it is more work and would need to be done carefully; I'm not sure any of the datasets are in enough disarray 😄 .
  • Add the datasets: We try to keep a high bar for adding new material, so adding new datasets while we are trying to streamline them doesn't feel right to me, but I'm open to a compelling case.

@gcapes
Copy link
Contributor

gcapes commented Nov 10, 2021

Thanks for the issue - it's like an example of how to write an issue. One point, made clearly, with links to the material. Great job!

I'd be in favour of adding the datasets because I can't see a compelling example using the existing files. While there is value to the 'thought experiment' aspect of a non-runnable example, all the examples could be attempted first as a thought experiment: think about it --> try it --> look at the solution. For these examples, we only have the first and last steps available.

I would wait until my PR has been merged before starting work on this. I've removed a good few unused files in that PR so I feel that adding files which will be used is justified.

@bielsnohr
Copy link
Author

Thanks for the responses! Nice to see a positive response, and also good to hear my issue writing skills are not as bad as I thought 😉

While there is value to the 'thought experiment' aspect of a non-runnable example, all the examples could be attempted first as a thought experiment: think about it --> try it --> look at the solution. For these examples, we only have the first and last steps available.

I agree completely. The problems can even explicitly state: "Please think about this first in your head and write down what you think the answer should be. Then try them here."

I would wait until my PR has been merged before starting work on this. I've removed a good few unused files in that PR so I feel that adding files which will be used is justified.

Agreed. If the data is going to be undergoing a big change, I am happy to wait for that PR to come through before starting work on this.

Also, tagging my colleague @kzscisoft who was involved in running the courses and forming this feedback.

@kzscisoft
Copy link

@gcapes This is definitely a model I think worked well within the courses we gave, those taking the course found it useful to first think about the solution then have the ability to confirm their thoughts. This means they are also more likely to share their thoughts with the group as well as they have that evidence.

@gcapes gcapes added status:wait Progress dependent on another issue or conversation type:enhancement Propose enhancement to the lesson labels Nov 11, 2021
@deppen8 deppen8 added help wanted Looking for Contributors and removed status:wait Progress dependent on another issue or conversation labels May 6, 2022
@deppen8
Copy link
Contributor

deppen8 commented May 6, 2022

Revisiting this Issue. @gcapes merged #1233 in March, so I think this is unblocked now. @bielsnohr or @kzscisoft , any interest in tackling this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Looking for Contributors type:enhancement Propose enhancement to the lesson
Projects
None yet
Development

No branches or pull requests

4 participants