Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Oct 9, 2020

Conversation

tobyhodges
Copy link
Member

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.

@maxim-belkin
Copy link
Contributor

Thanks, Toby!

@maxim-belkin
Copy link
Contributor

@swcarpentry/python-novice-inflammation-maintainers, once you review and approve it, make sure to "Rebase and merge" instead of "Squash and merge.

Copy link
Contributor

@ldko ldko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. Thank you, Toby! 👍

@ldko ldko merged commit 3b41589 into gh-pages Oct 9, 2020
@ldko ldko deleted the consistent-permalinks branch October 9, 2020 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants