make lesson suitable for teaching with locally-built (serverless) pages #878
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See discussion here for more background: datacarpentry/datacarpentry.github.io#542
In short, some Carpentries lessons use
/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. 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 Software 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://software-carpentry.org/lessons/ to the Instructor Notes page idn't broken, and make another sweep through the lesson pages too.