Skip to content

download html tag for carpentries_environment.yml does not work. #866

@noahbenson

Description

@noahbenson

In the new Python setup instructions for the SWC workshops that use Miniforge, the instructions ask students to download the carpentries_environment.yml file using a link. The link is coded in the HTML files using the download tag:

<a href="https://raw.githubusercontent.com/carpentries/workshop-template/refs/heads/gh-pages/data/carpentries_environment.yml" download>environment file</a> 

I believe that this tag unfortunately doesn't work if the link is to a different host, even if the webpage host is github.io and the link host is githubusercontent.com. When students click on this link, it opens a webpage displaying the YML file instead of downloading it—what we've observed is that students don't realize that the download hasn't happened in this case, so they go ahead and run the conda env create ... command (which gives them an error) and assume they are done. So when they get to the workshop, they have followed the instructions but do not have a carpentries environment.

My suggestion would be to edit the instructions here:

Download the <a href="https://raw.githubusercontent.com/carpentries/workshop-template/refs/heads/gh-pages/data/carpentries_environment.yml">environment file</a>
to your Downloads folder by right clicking on the link
and selecting "Save Link As...".

Alternatively, the environment file could be included in the workshop template so that the download link can be a local link.

If either of these seem like a good solution, I'm happy to submit a PR.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions