datacarpentry / ecology-workshop

Ecology Workshop Overview
http://www.datacarpentry.org/ecology-workshop/
Other
20 stars 34 forks source link

make lesson suitable for teaching with locally-built (serverless) pages #31

Closed tobyhodges closed 4 years ago

tobyhodges commented 4 years ago

See discussion here for more background: https://github.com/datacarpentry/datacarpentry.github.io/issues/542

In short, some Carpentries lessons use the path /guide/ for their Instructor Notes page and others use /guide/index.html (the default defined in _config.yml). This PR removes permalinks with a trailing slash from the YAML front matter of the Instructor Notes (_extras/guide.md) and other Extras files, consistent with new lessons created with the lesson template. Although there's no functional difference in the online versions of the lesson pages, pages with a trailing slash in the permalink will result in broken links in the version of the lesson built locally. Additionally, this lesson has various internal links and inclusions to provide setup instructions and information about the data set, which were often broken in the locally-built site. We'd like local builds to be usable e.g. in workshops taking place at locations with limited or unreliable Internet access.

Keeping the paths to these files consistent will also help us avoid broken links on the Data Carpentry Lessons page, and ensure that equivalent paths in new lessons created with the template are consistent with previously-developed lessons like this one.

I did a sweep through the lesson and adjusted internal links as part of this PR. If and when this is merged, I'll also make sure the link on https://datacarpentry.org/lessons/ to the Instructor Notes page isn't broken, and make another sweep through the lesson pages too.

Finally, I also removed the layout field from several pages, as the default layout is already set for Episodes and Extras pages in _config.yml.

tracykteal commented 4 years ago

Same, I have confidence in your changes @tobyhodges, and thanks for the updates. Fine by me to merge.