search

swcarpentry / python-novice-gapminder

Plotting and Programming in Python
http://swcarpentry.github.io/python-novice-gapminder/
Other
162 stars 428 forks source link

Possible incorrect link to Anaconda install instructions #646

Open marklcrowe opened 1 year ago

marklcrowe commented 1 year ago

The link at the bottom of page http://swcarpentry.github.io/python-novice-gapminder/ giving instructions for Anaconda installation "Python section of the workshop website for installation instructions" goes to an old template page with the header "FIXME". The actual information on that page is relevant and correct, but it seems wrong if it's directing people to a template-only page in a retired format.

alee commented 1 year ago

oof, thanks for letting us know! I think this is a broader question for the carpentries python maintainers and curriculum advisors @swcarpentry/curriculum-advisors

as I understand it atm these are shared instructional content across multiple carpentries python lessons...

tobyhodges commented 1 year ago

@marklcrowe thanks for raising this. While it is not ideal that the page has all those FIXMEs at the top, the workshop template itself is not retired. The lessons have moved over to the new infrastructure, but the https://carpentries.github.io/workshop-template/ template is still the default. (I hope we will have a new way of generating workshop websites soon, but not yet.)

meronvermaas commented 1 year ago

I noticed this as well, and it goes further than the python novice gapminder lesson material. Shell has the same link to the template page, which indeed is not very elegant. Interestingly (and applicable to this python lesson) the other python software carpentry found a more elegant solution: https://swcarpentry.github.io/python-novice-inflammation/index.html#setup Maybe this could be the text for the set-up of this lesson as well?

PS: The R lessons found a different solution without linking to the template as well.

zkamvar commented 1 year ago

The lessons have moved over to the new infrastructure, but the https://carpentries.github.io/workshop-template/ template is still the default.

A note on this: The Workshop template was built from the bones of the lesson template, but it serves a very different purpose (a template page for a single event that changes only a few variables vs. a long-lived document contributed to by many that can vary greatly in content) and thus requires a different mindset in the design. In fact, in 2019, there was an issue opened to remove the workshop template content from the original lesson template: https://github.com/carpentries/styles/issues/421. As Toby mentioned, it's not going anywhere for the moment because it still serves its purpose.

the other python software carpentry found a more elegant solution: https://swcarpentry.github.io/python-novice-inflammation/index.html#setup Maybe this could be the text for the set-up of this lesson as well?

I think this is a good solution and it's worth mentioning that this question about where setup instructions should live has been around for a while (see https://github.com/carpentries/maintainer-RFCs/issues/9) and we haven't been able to address it yet. Now that we have The Workbench in place, we may be able to implement a protocol to address it, but it will take some time to design it in a way that is both user-friendly and robust.