lesson-example icon indicating copy to clipboard operation
lesson-example copied to clipboard

Finding the data for the lesson

Open tracykteal opened this issue 8 years ago • 6 comments

Feedback from a recent discussion session was that they had trouble finding the data to use for the lesson. They didn't expect to find it in 'Setup' since that traditionally had been used for installation instructions.

Could there be a 'Data' tab, or maybe even better, a link to the data on the front page?

tracykteal avatar Aug 19 '16 16:08 tracykteal

A lesson's authors can add a link to a data set on the home page - should we resurrect the idea of 'Setup' as a callout box rather than a separate page, and encourage people to always put it on the home page?

gvwilson avatar Aug 19 '16 17:08 gvwilson

I also filed an issue on the Python lesson where it was noticed. https://github.com/swcarpentry/python-novice-inflammation/issues/302

Since the data is so important though, I think it would be good to have a standard location for it, so instructors always know where to find it.

tracykteal avatar Aug 19 '16 17:08 tracykteal

@k8hertweck can we please ask the maintainers whether we should:

  1. Include instructions in the prereq block on the home page and get rid of setup.md.
  2. Include a brief mention in the prereq block and link to setup (so that people are more likely to find it).
  3. Something else.

gvwilson avatar Sep 07 '16 19:09 gvwilson

@k8hertweck Did you ask the maintainers?

rgaiacs avatar Feb 04 '17 13:02 rgaiacs

Tracy, Naupaka, Trever, Remi and I got in consensus of

Include a brief mention in the prereq block and link to setup (so that people are more likely to find it).

rgaiacs avatar Feb 08 '17 17:02 rgaiacs

On Wed, Feb 08, 2017 at 09:53:05AM -0800, Raniere Silva wrote:

Include a brief mention in the prereq block and link to setup (so that people are more likely to find it).

And we do link to setup from both the nav bar 1 and the index page 2. I think we want to:

  • Move the ‘setup’ reference from just before the prereq block into the prereq block.
  • Mention in the referencing text that the setup link also covers any required data.
  • Mention in [3,4] that setup.md should also cover any required data.

wking avatar Feb 08 '17 18:02 wking