Use standard Gemfile from carpentries/lesson-example
vinisalazar opened this issue · comments
Hi!
I forked this repo with the intent of contributing to it.
When I tried to render the lesson locally, it failed with the following error:
Could not find gem 'mdl' in any of the gem sources listed in your Gemfile.
Run `bundle install` to install missing gems.
After running bundle install, the dependency was installed and I could render the lesson.
However, I propose that the template Gemfile from carpentries/lesson-example be used. This will ensure consistency with other lessons and thus helps to advance the development stage of this lesson. I was able to successfully render the lesson locally using this Gemfile.
I will submit a PR addressing this, but please feel free to reject it if there's a reason to use a custom Gemfile.
Best,
V
Hi V,
Yes, mdl is markdownlint, which we use to ensure good hygiene in our episodes and code snippets. This is not included in the upstream Gemfile, and most lessons do not scrub contributions this thoroughly. This is normally transparent to users and developers, as make serve calls bundle install before doing anything else.
We want to provide the folks running hpc-python with the ability to specialize the lesson for the particulars of their site and computational resources. This necessitates some small divergence from the upstream boilerplate, though we do try to keep in sync anyway. Closing this divergence would mean pushing our changes to the upstream repo -- which is not a bad idea, since there's a lot of Markdown in the Carpentries, and therefore a lot of lint.
Best,
T