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

Broken Link: Setting Up Python #93

Closed
mjones01 opened this issue Nov 8, 2016 · 8 comments
Closed

Broken Link: Setting Up Python #93

mjones01 opened this issue Nov 8, 2016 · 8 comments

Comments

@mjones01
Copy link

mjones01 commented Nov 8, 2016

In the Setting Up Python section, where it says "Here you can find a python script check_env.py".
The hyperlink to check_env.py is broken (http://www.datacarpentry.org/python-ecology-lesson/scripts/check_env.py).

The file is now in _includes/scripts/ .

@wrightaprilm
Copy link
Contributor

Accurate! Are you making a note of this as part of instructor training (i.e., declaring an intention to fix), or do you need me to tackle it?

@mjones01
Copy link
Author

@wrightaprilm Sorry for not being clear. I'm not sure the correct way to link to it now that it is in the _includes/ folder. I attempted to fix the link but was unsuccessful. It would be wonderful if you would.

@wrightaprilm
Copy link
Contributor

Oh, no problem, GitHub issues tracking is phenomenal, but when different audiences use it for different things, it can get a little hairy.

Anyway, it looks like it's a conflict between how the site builds and the directory layout of the materials. I'll get it figured out.

@wrightaprilm
Copy link
Contributor

OK, so here's what I did on this:

I looked at the way we have this set up. Data Carpentry workshops don't necessarily do git, and learners haven't always executed a command line program, nor do they necessarily know how to navigate the directory structure. I think we've jumped in at too high a level on that page. So I moved the instructions for this into the instructors guide, and am leaving it up to the instructor for how to provide the script. Possible avenues:

  • Having the learners do some cloning
  • Having them download the repo as a zip
  • Linking directly to the script from the workshop page
  • Providing it via dropbox or similar

What do you think?

@mjones01
Copy link
Author

I agree that it might be too high for some users and a direct link from a workshop page would probably work. As long as the script is mentioned in the INSTRUCTORS.md file (as it currently is) instructors will know that it is available. This does however preclude users from checking for correct installation prior to a workshop. Perhaps on the INSTRUCTOR.md file, you can add something like, "As an instructor you may consider adding a link to this script on the workshop page so that those users who are familiar with the command line can double check their installation prior to arriving at the workshop."
I'll defer on the final decision to your experience. I was actually using the lesson for self-learning to improve my skills with Python as I'm currently an R user & instructor. There was some discussion a few weeks ago on the DISCUSS listserv about usability of the SC/DC lessons for individual/online learning. I don't see this change detracting from workshop learning but it does remove the resource for someone learning independently (although that isn't a Data/Software Carpentry focus).

@mkuzak
Copy link
Member

mkuzak commented Jan 3, 2017

We can also link to raw version of the file on GitHub. This will make it easier to download.

@tracykteal
Copy link
Contributor

Linking to the raw file is probably the best solution. It is a good idea to still have it there for self-guided learning as @mjones01 says.

Adding a note that it's optional if you have access to a command line program is probably also useful.

@willingc
Copy link
Contributor

willingc commented Apr 6, 2017

I'll do a quick pr for this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants